{"openapi":"3.1.0","info":{"title":"Apizie","version":"2.0.0","description":"One API key, one envelope, many public data sources."},"servers":[{"url":"https://zieapi.vercel.app"}],"security":[{"ApiKeyAuth":[]}],"paths":{"/v1/cloud:amazonaws-ebs/complete-snapshot":{"post":{"operationId":"cloud_amazonaws_ebs_complete_snapshot","summary":"Seals and completes the snapshot after all of the required blocks of data have been written to it.…","description":"POST /snapshots/completion/{snapshotId}","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["snapshotId","x-amz-ChangedBlocksCount"],"properties":{"region":{"type":"string","enum":["us-east-1","us-east-2","us-west-1","us-west-2","us-gov-west-1","us-gov-east-1","ca-central-1","eu-north-1","eu-west-1","eu-west-2","eu-west-3","eu-central-1","eu-south-1","af-south-1","ap-northeast-1","ap-northeast-2","ap-northeast-3","ap-southeast-1","ap-southeast-2","ap-east-1","ap-south-1","sa-east-1","me-south-1"],"default":"us-east-1","description":"The AWS region"},"snapshotId":{"type":"string","description":"The ID of the snapshot."},"x-amz-ChangedBlocksCount":{"type":"integer","description":"The number of blocks that were written to the snapshot."},"x-amz-Checksum":{"type":"string","description":"An aggregated Base-64 SHA256 checksum based on the checksums of each written block. To generate the aggregated checksum using the linear…"},"x-amz-Checksum-Algorithm":{"type":"string","enum":["SHA256"],"description":"The algorithm used to generate the checksum. Currently, the only supported algorithm is SHA256 ."},"x-amz-Checksum-Aggregation-Method":{"type":"string","enum":["LINEAR"],"description":"The aggregation method used to generate the checksum. Currently, the only supported aggregation method is LINEAR ."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:amazonaws-ebs/get-snapshot-block":{"get":{"operationId":"cloud_amazonaws_ebs_get_snapshot_block","summary":"Returns the data in a block in an Amazon Elastic Block Store snapshot. You should always retry requests that…","description":"GET /snapshots/{snapshotId}/blocks/{blockIndex}","tags":["cloud"],"parameters":[{"name":"region","in":"query","required":false,"description":"The AWS region","schema":{"type":"string","enum":["us-east-1","us-east-2","us-west-1","us-west-2","us-gov-west-1","us-gov-east-1","ca-central-1","eu-north-1","eu-west-1","eu-west-2","eu-west-3","eu-central-1","eu-south-1","af-south-1","ap-northeast-1","ap-northeast-2","ap-northeast-3","ap-southeast-1","ap-southeast-2","ap-east-1","ap-south-1","sa-east-1","me-south-1"],"default":"us-east-1","description":"The AWS region"}},{"name":"snapshotId","in":"query","required":true,"description":"The ID of the snapshot containing the block from which to get data. If the specified snapshot is encrypted, you must have permission to…","schema":{"type":"string","description":"The ID of the snapshot containing the block from which to get data. If the specified snapshot is encrypted, you must have permission to…"}},{"name":"blockIndex","in":"query","required":true,"description":"The block index of the block in which to read the data. A block index is a logical index in units of 512 KiB blocks. To identify the block…","schema":{"type":"integer","description":"The block index of the block in which to read the data. A block index is a logical index in units of 512 KiB blocks. To identify the block…"}},{"name":"blockToken","in":"query","required":true,"description":"The block token of the block from which to get data. You can obtain the BlockToken by running the ListChangedBlocks or ListSnapshotBlocks…","schema":{"type":"string","description":"The block token of the block from which to get data. You can obtain the BlockToken by running the ListChangedBlocks or ListSnapshotBlocks…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/cloud:amazonaws-ebs/list-changed-blocks":{"get":{"operationId":"cloud_amazonaws_ebs_list_changed_blocks","summary":"Returns information about the blocks that are different between two Amazon Elastic Block Store snapshots of…","description":"GET /snapshots/{secondSnapshotId}/changedblocks","tags":["cloud"],"parameters":[{"name":"region","in":"query","required":false,"description":"The AWS region","schema":{"type":"string","enum":["us-east-1","us-east-2","us-west-1","us-west-2","us-gov-west-1","us-gov-east-1","ca-central-1","eu-north-1","eu-west-1","eu-west-2","eu-west-3","eu-central-1","eu-south-1","af-south-1","ap-northeast-1","ap-northeast-2","ap-northeast-3","ap-southeast-1","ap-southeast-2","ap-east-1","ap-south-1","sa-east-1","me-south-1"],"default":"us-east-1","description":"The AWS region"}},{"name":"firstSnapshotId","in":"query","required":false,"description":"The ID of the first snapshot to use for the comparison. The FirstSnapshotID parameter must be specified with a SecondSnapshotId parameter;…","schema":{"type":"string","description":"The ID of the first snapshot to use for the comparison. The FirstSnapshotID parameter must be specified with a SecondSnapshotId parameter;…"}},{"name":"secondSnapshotId","in":"query","required":true,"description":"The ID of the second snapshot to use for the comparison. The SecondSnapshotId parameter must be specified with a FirstSnapshotID…","schema":{"type":"string","description":"The ID of the second snapshot to use for the comparison. The SecondSnapshotId parameter must be specified with a FirstSnapshotID…"}},{"name":"pageToken","in":"query","required":false,"description":"The token to request the next page of results. If you specify NextToken , then StartingBlockIndex is ignored.","schema":{"type":"string","description":"The token to request the next page of results. If you specify NextToken , then StartingBlockIndex is ignored."}},{"name":"maxResults","in":"query","required":false,"description":"The maximum number of blocks to be returned by the request. Even if additional blocks can be retrieved from the snapshot, the request can…","schema":{"type":"integer","description":"The maximum number of blocks to be returned by the request. Even if additional blocks can be retrieved from the snapshot, the request can…"}},{"name":"startingBlockIndex","in":"query","required":false,"description":"The block index from which the comparison should start. The list in the response will start from this block index or the next valid block…","schema":{"type":"integer","description":"The block index from which the comparison should start. The list in the response will start from this block index or the next valid block…"}},{"name":"MaxResults","in":"query","required":false,"description":"Pagination limit","schema":{"type":"string","description":"Pagination limit"}},{"name":"NextToken","in":"query","required":false,"description":"Pagination token","schema":{"type":"string","description":"Pagination token"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/cloud:amazonaws-ebs/list-snapshot-blocks":{"get":{"operationId":"cloud_amazonaws_ebs_list_snapshot_blocks","summary":"Returns information about the blocks in an Amazon Elastic Block Store snapshot. You should always retry…","description":"GET /snapshots/{snapshotId}/blocks","tags":["cloud"],"parameters":[{"name":"region","in":"query","required":false,"description":"The AWS region","schema":{"type":"string","enum":["us-east-1","us-east-2","us-west-1","us-west-2","us-gov-west-1","us-gov-east-1","ca-central-1","eu-north-1","eu-west-1","eu-west-2","eu-west-3","eu-central-1","eu-south-1","af-south-1","ap-northeast-1","ap-northeast-2","ap-northeast-3","ap-southeast-1","ap-southeast-2","ap-east-1","ap-south-1","sa-east-1","me-south-1"],"default":"us-east-1","description":"The AWS region"}},{"name":"snapshotId","in":"query","required":true,"description":"The ID of the snapshot from which to get block indexes and block tokens.","schema":{"type":"string","description":"The ID of the snapshot from which to get block indexes and block tokens."}},{"name":"pageToken","in":"query","required":false,"description":"The token to request the next page of results. If you specify NextToken , then StartingBlockIndex is ignored.","schema":{"type":"string","description":"The token to request the next page of results. If you specify NextToken , then StartingBlockIndex is ignored."}},{"name":"maxResults","in":"query","required":false,"description":"The maximum number of blocks to be returned by the request. Even if additional blocks can be retrieved from the snapshot, the request can…","schema":{"type":"integer","description":"The maximum number of blocks to be returned by the request. Even if additional blocks can be retrieved from the snapshot, the request can…"}},{"name":"startingBlockIndex","in":"query","required":false,"description":"The block index from which the list should start. The list in the response will start from this block index or the next valid block index…","schema":{"type":"integer","description":"The block index from which the list should start. The list in the response will start from this block index or the next valid block index…"}},{"name":"MaxResults","in":"query","required":false,"description":"Pagination limit","schema":{"type":"string","description":"Pagination limit"}},{"name":"NextToken","in":"query","required":false,"description":"Pagination token","schema":{"type":"string","description":"Pagination token"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/cloud:amazonaws-ebs/put-snapshot-block":{"post":{"operationId":"cloud_amazonaws_ebs_put_snapshot_block","summary":"Writes a block of data to a snapshot. If the specified block contains data, the existing data is…","description":"PUT /snapshots/{snapshotId}/blocks/{blockIndex}","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["snapshotId","blockIndex","x-amz-Data-Length","x-amz-Checksum","x-amz-Checksum-Algorithm","body"],"properties":{"region":{"type":"string","enum":["us-east-1","us-east-2","us-west-1","us-west-2","us-gov-west-1","us-gov-east-1","ca-central-1","eu-north-1","eu-west-1","eu-west-2","eu-west-3","eu-central-1","eu-south-1","af-south-1","ap-northeast-1","ap-northeast-2","ap-northeast-3","ap-southeast-1","ap-southeast-2","ap-east-1","ap-south-1","sa-east-1","me-south-1"],"default":"us-east-1","description":"The AWS region"},"snapshotId":{"type":"string","description":"The ID of the snapshot. If the specified snapshot is encrypted, you must have permission to use the KMS key that was used to encrypt the…"},"blockIndex":{"type":"integer","description":"The block index of the block in which to write the data. A block index is a logical index in units of 512 KiB blocks. To identify the…"},"x-amz-Data-Length":{"type":"integer","description":"The size of the data to write to the block, in bytes. Currently, the only supported size is 524288 bytes. Valid values: 524288"},"x-amz-Progress":{"type":"integer","description":"The progress of the write process, as a percentage."},"x-amz-Checksum":{"type":"string","description":"A Base64-encoded SHA256 checksum of the data. Only SHA256 checksums are supported."},"x-amz-Checksum-Algorithm":{"type":"string","enum":["SHA256"],"description":"The algorithm used to generate the checksum. Currently, the only supported algorithm is SHA256 ."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:amazonaws-ebs/start-snapshot":{"post":{"operationId":"cloud_amazonaws_ebs_start_snapshot","summary":"Creates a new Amazon EBS snapshot. The new snapshot enters the pending state after the request completes.…","description":"POST /snapshots","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"region":{"type":"string","enum":["us-east-1","us-east-2","us-west-1","us-west-2","us-gov-west-1","us-gov-east-1","ca-central-1","eu-north-1","eu-west-1","eu-west-2","eu-west-3","eu-central-1","eu-south-1","af-south-1","ap-northeast-1","ap-northeast-2","ap-northeast-3","ap-southeast-1","ap-southeast-2","ap-east-1","ap-south-1","sa-east-1","me-south-1"],"default":"us-east-1","description":"The AWS region"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}}},"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"x-api-key"}},"schemas":{"RunEnvelope":{"type":"object","required":["project","data","timestamp"],"properties":{"project":{"type":"string","example":"dev-tools:hash"},"data":{},"timestamp":{"type":"string","format":"date-time"}}},"ErrorEnvelope":{"type":"object","properties":{"content":{},"message":{"type":"string"},"errors":{"type":"array","items":{}},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}}}}}},"responses":{"Error":{"description":"Invalid key, plan gate, rate limit or upstream failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}}}}