openapi: 3.0.0 info: version: 2015-07-09 x-release: v4 title: APIs.io Engineering Platform Amazon API Gateway 2014 11 13 Workers KV Namespace API description: Amazon API Gateway

Amazon API Gateway helps developers deliver robust, secure, and scalable mobile and web application back ends. API Gateway allows developers to securely connect mobile and web applications to APIs that run on AWS Lambda, Amazon EC2, or other publicly addressable web services that are hosted outside of AWS.

x-logo: url: https://api.apis.guru/v2/cache/logo/https_twitter.com_awscloud_profile_image.png backgroundColor: '#FFFFFF' termsOfService: https://aws.amazon.com/service-terms/ contact: name: Mike Ralphson email: mike.ralphson@gmail.com url: https://github.com/mermade/aws2openapi x-twitter: PermittedSoc license: name: Apache 2.0 License url: http://www.apache.org/licenses/ x-providerName: amazonaws.com x-serviceName: apigateway x-origin: - contentType: application/json url: https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/apigateway-2015-07-09.normal.json converter: url: https://github.com/mermade/aws2openapi version: 1.0.0 x-apisguru-driver: external x-apiClientRegistration: url: https://portal.aws.amazon.com/gp/aws/developer/registration/index.html?nc2=h_ct x-apisguru-categories: - cloud x-preferred: true servers: - url: http://apigateway.{region}.amazonaws.com variables: region: description: The AWS region 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 Amazon API Gateway multi-region endpoint - url: https://apigateway.{region}.amazonaws.com variables: region: description: The AWS region 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 Amazon API Gateway multi-region endpoint - url: http://apigateway.{region}.amazonaws.com.cn variables: region: description: The AWS region enum: - cn-north-1 - cn-northwest-1 default: cn-north-1 description: The Amazon API Gateway endpoint for China (Beijing) and China (Ningxia) - url: https://apigateway.{region}.amazonaws.com.cn variables: region: description: The AWS region enum: - cn-north-1 - cn-northwest-1 default: cn-north-1 description: The Amazon API Gateway endpoint for China (Beijing) and China (Ningxia) security: - hmac: [] tags: - name: Workers KV Namespace paths: /accounts/{account_id}/storage/kv/namespaces: get: description: Returns the namespaces owned by an account. operationId: workers-kv-namespace-list-namespaces parameters: - in: path name: account_id required: true schema: $ref: '#/components/schemas/workers-kv_identifier' - in: query name: page schema: default: 1 description: Page number of paginated results. minimum: 1 type: number - in: query name: per_page schema: default: 20 description: Maximum number of results per page. maximum: 100 minimum: 5 type: number - in: query name: order schema: description: Field to order results by. enum: - id - title example: id - in: query name: direction schema: description: Direction to order namespaces. enum: - asc - desc example: asc responses: 4XX: content: application/json: schema: $ref: '#/components/schemas/workers-kv_api-response-common-failure' description: List Namespaces response failure '200': content: application/json: schema: allOf: - $ref: '#/components/schemas/workers-kv_api-response-collection' - properties: result: items: $ref: '#/components/schemas/workers-kv_namespace' type: array type: object description: List Namespaces response security: - api_token: [] - api_email: [] api_key: [] summary: APIs.io Engineering Platform List Namespaces tags: - Workers KV Namespace x-api-token-group: - Workers KV Storage Write - Workers KV Storage Read x-cfPermissionsRequired: enum: - com.cloudflare.edge.storage.kv.namespace.list post: description: Creates a namespace under the given title. A `400` is returned if the account already owns a namespace with this title. A namespace must be explicitly deleted to be replaced. operationId: workers-kv-namespace-create-a-namespace parameters: - in: path name: account_id required: true schema: $ref: '#/components/schemas/workers-kv_identifier' requestBody: content: application/json: schema: $ref: '#/components/schemas/workers-kv_create_rename_namespace_body' required: true responses: 4XX: content: application/json: schema: $ref: '#/components/schemas/workers-kv_api-response-common-failure' description: Create a Namespace response failure '200': content: application/json: schema: allOf: - $ref: '#/components/schemas/workers-kv_api-response-common' - properties: result: $ref: '#/components/schemas/workers-kv_namespace' type: object description: Create a Namespace response security: - api_token: [] - api_email: [] api_key: [] summary: APIs.io Engineering Platform Create a Namespace tags: - Workers KV Namespace x-api-token-group: - Workers KV Storage Write x-cfPermissionsRequired: enum: - com.cloudflare.edge.storage.kv.namespace.create /accounts/{account_id}/storage/kv/namespaces/{namespace_id}: delete: description: Deletes the namespace corresponding to the given ID. operationId: workers-kv-namespace-remove-a-namespace parameters: - in: path name: namespace_id required: true schema: $ref: '#/components/schemas/workers-kv_namespace_identifier' - in: path name: account_id required: true schema: $ref: '#/components/schemas/workers-kv_identifier' requestBody: content: application/json: {} required: true responses: 4XX: content: application/json: schema: $ref: '#/components/schemas/workers-kv_api-response-common-failure' description: Remove a Namespace response failure '200': content: application/json: schema: $ref: '#/components/schemas/workers-kv_api-response-common-no-result' description: Remove a Namespace response security: - api_token: [] - api_email: [] api_key: [] summary: APIs.io Engineering Platform Remove a Namespace tags: - Workers KV Namespace x-api-token-group: - Workers KV Storage Write x-cfPermissionsRequired: enum: - com.cloudflare.edge.storage.kv.namespace.delete get: description: Get the namespace corresponding to the given ID. operationId: workers-kv-namespace-get-a-namespace parameters: - in: path name: namespace_id required: true schema: $ref: '#/components/schemas/workers-kv_namespace_identifier' - in: path name: account_id required: true schema: $ref: '#/components/schemas/workers-kv_identifier' responses: 4XX: content: application/json: schema: $ref: '#/components/schemas/workers-kv_api-response-common-failure' description: Get a Namespace response failure '200': content: application/json: schema: allOf: - $ref: '#/components/schemas/workers-kv_api-response-common' - properties: result: $ref: '#/components/schemas/workers-kv_namespace' type: object description: Get a Namespace response security: - api_token: [] - api_email: [] api_key: [] summary: APIs.io Engineering Platform Get a Namespace tags: - Workers KV Namespace x-api-token-group: - Workers KV Storage Write - Workers KV Storage Read x-cfPermissionsRequired: enum: - com.cloudflare.edge.storage.kv.namespace.read put: description: Modifies a namespace's title. operationId: workers-kv-namespace-rename-a-namespace parameters: - in: path name: namespace_id required: true schema: $ref: '#/components/schemas/workers-kv_namespace_identifier' - in: path name: account_id required: true schema: $ref: '#/components/schemas/workers-kv_identifier' requestBody: content: application/json: schema: $ref: '#/components/schemas/workers-kv_create_rename_namespace_body' required: true responses: 4XX: content: application/json: schema: $ref: '#/components/schemas/workers-kv_api-response-common-failure' description: Rename a Namespace response failure '200': content: application/json: schema: $ref: '#/components/schemas/workers-kv_api-response-common-no-result' description: Rename a Namespace response security: - api_token: [] - api_email: [] api_key: [] summary: APIs.io Engineering Platform Rename a Namespace tags: - Workers KV Namespace x-api-token-group: - Workers KV Storage Write x-cfPermissionsRequired: enum: - com.cloudflare.edge.storage.kv.namespace.delete /accounts/{account_id}/storage/kv/namespaces/{namespace_id}/bulk: delete: deprecated: true description: Remove multiple KV pairs from the namespace. Body should be an array of up to 10,000 keys to be removed. operationId: workers-kv-namespace-delete-multiple-key-value-pairs-deprecated parameters: - in: path name: namespace_id required: true schema: $ref: '#/components/schemas/workers-kv_namespace_identifier' - in: path name: account_id required: true schema: $ref: '#/components/schemas/workers-kv_identifier' requestBody: content: application/json: schema: $ref: '#/components/schemas/workers-kv_bulk_delete' required: true responses: 4XX: content: application/json: schema: $ref: '#/components/schemas/workers-kv_api-response-common-failure' description: Delete multiple key-value pairs response failure '200': content: application/json: schema: $ref: '#/components/schemas/workers-kv_api-response-common-no-result' description: Delete multiple key-value pairs response security: - api_token: [] - api_email: [] api_key: [] summary: APIs.io Engineering Platform Delete multiple key-value pairs tags: - Workers KV Namespace x-api-token-group: - Workers KV Storage Write x-cfPermissionsRequired: enum: - com.cloudflare.edge.storage.kv.key.delete put: description: Write multiple keys and values at once. Body should be an array of up to 10,000 key-value pairs to be stored, along with optional expiration information. Existing values and expirations will be overwritten. If neither `expiration` nor `expiration_ttl` is specified, the key-value pair will never expire. If both are set, `expiration_ttl` is used and `expiration` is ignored. The entire request size must be 100 megabytes or less. operationId: workers-kv-namespace-write-multiple-key-value-pairs parameters: - in: path name: namespace_id required: true schema: $ref: '#/components/schemas/workers-kv_namespace_identifier' - in: path name: account_id required: true schema: $ref: '#/components/schemas/workers-kv_identifier' requestBody: content: application/json: schema: $ref: '#/components/schemas/workers-kv_bulk_write' required: true responses: 4XX: content: application/json: schema: $ref: '#/components/schemas/workers-kv_api-response-common-failure' description: Write multiple key-value pairs response failure '200': content: application/json: schema: $ref: '#/components/schemas/workers-kv_api-response-common-no-result' description: Write multiple key-value pairs response security: - api_token: [] - api_email: [] api_key: [] summary: APIs.io Engineering Platform Write multiple key-value pairs tags: - Workers KV Namespace x-api-token-group: - Workers KV Storage Write x-cfPermissionsRequired: enum: - com.cloudflare.edge.storage.kv.key.update /accounts/{account_id}/storage/kv/namespaces/{namespace_id}/bulk/delete: post: description: Remove multiple KV pairs from the namespace. Body should be an array of up to 10,000 keys to be removed. operationId: workers-kv-namespace-delete-multiple-key-value-pairs parameters: - in: path name: namespace_id required: true schema: $ref: '#/components/schemas/workers-kv_namespace_identifier' - in: path name: account_id required: true schema: $ref: '#/components/schemas/workers-kv_identifier' requestBody: content: application/json: schema: $ref: '#/components/schemas/workers-kv_bulk_delete' required: true responses: 4XX: content: application/json: schema: $ref: '#/components/schemas/workers-kv_api-response-common-failure' description: Delete multiple key-value pairs response failure '200': content: application/json: schema: $ref: '#/components/schemas/workers-kv_api-response-common-no-result' description: Delete multiple key-value pairs response security: - api_token: [] - api_email: [] api_key: [] summary: APIs.io Engineering Platform Delete multiple key-value pairs tags: - Workers KV Namespace x-api-token-group: - Workers KV Storage Write x-cfPermissionsRequired: enum: - com.cloudflare.edge.storage.kv.key.delete /accounts/{account_id}/storage/kv/namespaces/{namespace_id}/keys: get: description: Lists a namespace's keys. operationId: workers-kv-namespace-list-a-namespace'-s-keys parameters: - in: path name: namespace_id required: true schema: $ref: '#/components/schemas/workers-kv_namespace_identifier' - in: path name: account_id required: true schema: $ref: '#/components/schemas/workers-kv_identifier' - in: query name: limit schema: default: 1000 description: The number of keys to return. The cursor attribute may be used to iterate over the next batch of keys if there are more than the limit. maximum: 1000 minimum: 10 type: number - in: query name: prefix schema: description: A string prefix used to filter down which keys will be returned. Exact matches and any key names that begin with the prefix will be returned. example: My-Prefix type: string - in: query name: cursor schema: description: Opaque token indicating the position from which to continue when requesting the next set of records if the amount of list results was limited by the limit parameter. A valid value for the cursor can be obtained from the `cursors` object in the `result_info` structure. example: 6Ck1la0VxJ0djhidm1MdX2FyDGxLKVeeHZZmORS_8XeSuhz9SjIJRaSa2lnsF01tQOHrfTGAP3R5X1Kv5iVUuMbNKhWNAXHOl6ePB0TUL8nw type: string responses: 4XX: content: application/json: schema: $ref: '#/components/schemas/workers-kv_api-response-common-failure' description: List a Namespace's Keys response failure '200': content: application/json: schema: allOf: - $ref: '#/components/schemas/workers-kv_api-response-common' - properties: result: items: $ref: '#/components/schemas/workers-kv_key' type: array result_info: properties: count: description: Total results returned based on your list parameters. example: 1 type: number cursor: $ref: '#/components/schemas/workers-kv_cursor' description: List a Namespace's Keys response security: - api_token: [] - api_email: [] api_key: [] summary: APIs.io Engineering Platform List a Namespace's Keys tags: - Workers KV Namespace x-api-token-group: - Workers KV Storage Write - Workers KV Storage Read x-cfPermissionsRequired: enum: - com.cloudflare.edge.storage.kv.key.list /accounts/{account_id}/storage/kv/namespaces/{namespace_id}/metadata/{key_name}: get: description: Returns the metadata associated with the given key in the given namespace. Use URL-encoding to use special characters (for example, `:`, `!`, `%`) in the key name. operationId: workers-kv-namespace-read-the-metadata-for-a-key parameters: - in: path name: key_name required: true schema: $ref: '#/components/schemas/workers-kv_key_name' - in: path name: namespace_id required: true schema: $ref: '#/components/schemas/workers-kv_namespace_identifier' - in: path name: account_id required: true schema: $ref: '#/components/schemas/workers-kv_identifier' responses: 4XX: content: application/json: schema: $ref: '#/components/schemas/workers-kv_api-response-common-failure' description: Read the metadata for a key response failure '200': content: application/json: schema: allOf: - $ref: '#/components/schemas/workers-kv_api-response-common' - properties: result: $ref: '#/components/schemas/workers-kv_list_metadata' description: Read the metadata for a key response security: - api_token: [] - api_email: [] api_key: [] summary: APIs.io Engineering Platform Read the metadata for a key tags: - Workers KV Namespace x-cfPermissionsRequired: enum: - com.cloudflare.edge.storage.kv.key.read /accounts/{account_id}/storage/kv/namespaces/{namespace_id}/values/{key_name}: delete: description: Remove a KV pair from the namespace. Use URL-encoding to use special characters (for example, `:`, `!`, `%`) in the key name. operationId: workers-kv-namespace-delete-key-value-pair parameters: - in: path name: key_name required: true schema: $ref: '#/components/schemas/workers-kv_key_name' - in: path name: namespace_id required: true schema: $ref: '#/components/schemas/workers-kv_namespace_identifier' - in: path name: account_id required: true schema: $ref: '#/components/schemas/workers-kv_identifier' requestBody: content: application/json: {} required: true responses: 4XX: content: application/json: schema: $ref: '#/components/schemas/workers-kv_api-response-common-failure' description: Delete key-value pair response failure '200': content: application/json: schema: $ref: '#/components/schemas/workers-kv_api-response-common-no-result' description: Delete key-value pair response security: - api_token: [] - api_email: [] api_key: [] summary: APIs.io Engineering Platform Delete key-value pair tags: - Workers KV Namespace x-api-token-group: - Workers KV Storage Write x-cfPermissionsRequired: enum: - com.cloudflare.edge.storage.kv.key.delete get: description: Returns the value associated with the given key in the given namespace. Use URL-encoding to use special characters (for example, `:`, `!`, `%`) in the key name. If the KV-pair is set to expire at some point, the expiration time as measured in seconds since the UNIX epoch will be returned in the `expiration` response header. operationId: workers-kv-namespace-read-key-value-pair parameters: - in: path name: key_name required: true schema: $ref: '#/components/schemas/workers-kv_key_name' - in: path name: namespace_id required: true schema: $ref: '#/components/schemas/workers-kv_namespace_identifier' - in: path name: account_id required: true schema: $ref: '#/components/schemas/workers-kv_identifier' responses: 4XX: content: application/json: schema: $ref: '#/components/schemas/workers-kv_api-response-common-failure' description: Read key-value pair response failure '200': content: application/octet-stream: schema: $ref: '#/components/schemas/workers-kv_value' description: Read key-value pair response security: - api_token: [] - api_email: [] api_key: [] summary: APIs.io Engineering Platform Read key-value pair tags: - Workers KV Namespace x-api-token-group: - Workers KV Storage Write - Workers KV Storage Read x-cfPermissionsRequired: enum: - com.cloudflare.edge.storage.kv.key.read put: description: Write a value identified by a key. Use URL-encoding to use special characters (for example, `:`, `!`, `%`) in the key name. Body should be the value to be stored along with JSON metadata to be associated with the key/value pair. Existing values, expirations, and metadata will be overwritten. If neither `expiration` nor `expiration_ttl` is specified, the key-value pair will never expire. If both are set, `expiration_ttl` is used and `expiration` is ignored. operationId: workers-kv-namespace-write-key-value-pair-with-metadata parameters: - in: path name: key_name required: true schema: $ref: '#/components/schemas/workers-kv_key_name' - in: path name: namespace_id required: true schema: $ref: '#/components/schemas/workers-kv_namespace_identifier' - in: path name: account_id required: true schema: $ref: '#/components/schemas/workers-kv_identifier' requestBody: content: '*/*': schema: $ref: '#/components/schemas/workers-kv_value' multipart/form-data: schema: properties: metadata: $ref: '#/components/schemas/workers-kv_metadata' value: $ref: '#/components/schemas/workers-kv_value' required: - value - metadata type: object required: true responses: 4XX: content: application/json: schema: $ref: '#/components/schemas/workers-kv_api-response-common-failure' description: Write key-value pair with metadata response failure '200': content: application/json: schema: $ref: '#/components/schemas/workers-kv_api-response-common-no-result' description: Write key-value pair with metadata response security: - api_token: [] - api_email: [] api_key: [] summary: APIs.io Engineering Platform Write key-value pair with metadata tags: - Workers KV Namespace x-api-token-group: - Workers KV Storage Write x-cfPermissionsRequired: enum: - com.cloudflare.edge.storage.kv.key.update components: schemas: workers-kv_namespace: properties: id: $ref: '#/components/schemas/workers-kv_namespace_identifier' supports_url_encoding: description: True if keys written on the URL will be URL-decoded before storing. For example, if set to "true", a key written on the URL as "%3F" will be stored as "?". example: true readOnly: true type: boolean title: $ref: '#/components/schemas/workers-kv_namespace_title' required: - id - title type: object workers-kv_api-response-common-no-result: allOf: - $ref: '#/components/schemas/workers-kv_api-response-common' - properties: result: nullable: true type: object x-stainless-empty-object: true type: object workers-kv_namespace_title: description: A human-readable string name for a Namespace. example: My Own Namespace type: string workers-kv_create_rename_namespace_body: properties: title: $ref: '#/components/schemas/workers-kv_namespace_title' required: - title type: object workers-kv_metadata: description: Arbitrary JSON to be associated with a key/value pair. example: '{"someMetadataKey": "someMetadataValue"}' type: string workers-kv_expiration_ttl: description: The number of seconds for which the key should be visible before it expires. At least 60. example: 300 type: number workers-kv_cursor: description: Opaque token indicating the position from which to continue when requesting the next set of records if the amount of list results was limited by the limit parameter. A valid value for the cursor can be obtained from the cursors object in the result_info structure. example: 6Ck1la0VxJ0djhidm1MdX2FyDGxLKVeeHZZmORS_8XeSuhz9SjIJRaSa2lnsF01tQOHrfTGAP3R5X1Kv5iVUuMbNKhWNAXHOl6ePB0TUL8nw type: string workers-kv_key_name: description: A key's name. The name may be at most 512 bytes. All printable, non-whitespace characters are valid. Use percent-encoding to define key names as part of a URL. example: My-Key maxLength: 512 type: string workers-kv_identifier: description: Identifier example: 023e105f4ecef8ad9ca31a8372d0c353 maxLength: 32 readOnly: true type: string workers-kv_value: description: A byte sequence to be stored, up to 25 MiB in length. example: Some Value type: string workers-kv_result_info: properties: count: description: Total number of results for the requested service example: 1 type: number page: description: Current page within paginated list of results example: 1 type: number per_page: description: Number of results per page of results example: 20 type: number total_count: description: Total results available without any search parameters example: 2000 type: number type: object workers-kv_key: description: A name for a value. A value stored under a given key may be retrieved via the same key. properties: expiration: description: The time, measured in number of seconds since the UNIX epoch, at which the key will expire. This property is omitted for keys that will not expire. example: 1577836800.0 type: number metadata: $ref: '#/components/schemas/workers-kv_list_metadata' name: $ref: '#/components/schemas/workers-kv_key_name' required: - name type: object workers-kv_key_name_bulk: description: A key's name. The name may be at most 512 bytes. All printable, non-whitespace characters are valid. example: My-Key maxLength: 512 type: string workers-kv_list_metadata: additionalProperties: true description: Arbitrary JSON that is associated with a key. example: someMetadataKey: someMetadataValue type: object workers-kv_api-response-common: properties: errors: $ref: '#/components/schemas/workers-kv_messages' messages: $ref: '#/components/schemas/workers-kv_messages' success: description: Whether the API call was successful enum: - true example: true type: boolean required: - success - errors - messages type: object workers-kv_api-response-collection: allOf: - $ref: '#/components/schemas/workers-kv_api-response-common' - properties: result_info: $ref: '#/components/schemas/workers-kv_result_info' type: object type: object workers-kv_api-response-common-failure: properties: errors: allOf: - $ref: '#/components/schemas/workers-kv_messages' example: - code: 7003 message: No route for the URI minLength: 1 messages: allOf: - $ref: '#/components/schemas/workers-kv_messages' example: [] result: nullable: true type: object success: description: Whether the API call was successful enum: - false example: false type: boolean required: - success - errors - messages - result type: object workers-kv_expiration: description: The time, measured in number of seconds since the UNIX epoch, at which the key should expire. example: 1578435000.0 type: number workers-kv_namespace_identifier: description: Namespace identifier tag. example: 0f2ac74b498b48028cb68387c421e279 maxLength: 32 readOnly: true type: string workers-kv_messages: example: [] items: properties: code: minimum: 1000 type: integer message: type: string required: - code - message type: object uniqueItems: true type: array workers-kv_bulk_write: items: properties: base64: default: false description: Whether or not the server should base64 decode the value before storing it. Useful for writing values that wouldn't otherwise be valid JSON strings, such as images. type: boolean expiration: $ref: '#/components/schemas/workers-kv_expiration' expiration_ttl: $ref: '#/components/schemas/workers-kv_expiration_ttl' key: $ref: '#/components/schemas/workers-kv_key_name_bulk' metadata: $ref: '#/components/schemas/workers-kv_list_metadata' value: description: A UTF-8 encoded string to be stored, up to 25 MiB in length. example: Some string maxLength: 26214400 type: string type: object required: - key - value type: array workers-kv_bulk_delete: items: $ref: '#/components/schemas/workers-kv_key_name_bulk' type: array securitySchemes: hmac: type: apiKey name: Authorization in: header description: Amazon Signature authorization v4 x-amazon-apigateway-authtype: awsSigv4 externalDocs: description: Amazon Web Services documentation url: https://docs.aws.amazon.com/apigateway/ x-hasEquivalentPaths: true