{ "opencollection": "1.0.0", "info": { "name": "APIs.io Engineering Platform Amazon API Gateway 2014 11 13 Workers KV Namespace API", "version": "1.0.0" }, "request": { "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "items": [ { "info": { "name": "Workers KV Namespace", "type": "folder" }, "items": [ { "info": { "name": "APIs.io Engineering Platform List Namespaces", "type": "http" }, "http": { "method": "GET", "url": "http://apigateway.{region}.amazonaws.com/accounts/:account_id/storage/kv/namespaces", "params": [ { "name": "account_id", "value": "", "type": "path" }, { "name": "page", "value": "", "type": "query" }, { "name": "per_page", "value": "", "type": "query" }, { "name": "order", "value": "", "type": "query" }, { "name": "direction", "value": "", "type": "query" } ] }, "docs": "Returns the namespaces owned by an account." }, { "info": { "name": "APIs.io Engineering Platform Create a Namespace", "type": "http" }, "http": { "method": "POST", "url": "http://apigateway.{region}.amazonaws.com/accounts/:account_id/storage/kv/namespaces", "params": [ { "name": "account_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "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." }, { "info": { "name": "APIs.io Engineering Platform Get a Namespace", "type": "http" }, "http": { "method": "GET", "url": "http://apigateway.{region}.amazonaws.com/accounts/:account_id/storage/kv/namespaces/:namespace_id", "params": [ { "name": "namespace_id", "value": "", "type": "path" }, { "name": "account_id", "value": "", "type": "path" } ] }, "docs": "Get the namespace corresponding to the given ID." }, { "info": { "name": "APIs.io Engineering Platform Rename a Namespace", "type": "http" }, "http": { "method": "PUT", "url": "http://apigateway.{region}.amazonaws.com/accounts/:account_id/storage/kv/namespaces/:namespace_id", "params": [ { "name": "namespace_id", "value": "", "type": "path" }, { "name": "account_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Modifies a namespace's title." }, { "info": { "name": "APIs.io Engineering Platform Remove a Namespace", "type": "http" }, "http": { "method": "DELETE", "url": "http://apigateway.{region}.amazonaws.com/accounts/:account_id/storage/kv/namespaces/:namespace_id", "params": [ { "name": "namespace_id", "value": "", "type": "path" }, { "name": "account_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Deletes the namespace corresponding to the given ID." }, { "info": { "name": "APIs.io Engineering Platform Write multiple key-value pairs", "type": "http" }, "http": { "method": "PUT", "url": "http://apigateway.{region}.amazonaws.com/accounts/:account_id/storage/kv/namespaces/:namespace_id/bulk", "params": [ { "name": "namespace_id", "value": "", "type": "path" }, { "name": "account_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "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." }, { "info": { "name": "APIs.io Engineering Platform Delete multiple key-value pairs", "type": "http" }, "http": { "method": "DELETE", "url": "http://apigateway.{region}.amazonaws.com/accounts/:account_id/storage/kv/namespaces/:namespace_id/bulk", "params": [ { "name": "namespace_id", "value": "", "type": "path" }, { "name": "account_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Remove multiple KV pairs from the namespace. Body should be an array of up to 10,000 keys to be removed." }, { "info": { "name": "APIs.io Engineering Platform Delete multiple key-value pairs", "type": "http" }, "http": { "method": "POST", "url": "http://apigateway.{region}.amazonaws.com/accounts/:account_id/storage/kv/namespaces/:namespace_id/bulk/delete", "params": [ { "name": "namespace_id", "value": "", "type": "path" }, { "name": "account_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Remove multiple KV pairs from the namespace. Body should be an array of up to 10,000 keys to be removed." }, { "info": { "name": "APIs.io Engineering Platform List a Namespace's Keys", "type": "http" }, "http": { "method": "GET", "url": "http://apigateway.{region}.amazonaws.com/accounts/:account_id/storage/kv/namespaces/:namespace_id/keys", "params": [ { "name": "namespace_id", "value": "", "type": "path" }, { "name": "account_id", "value": "", "type": "path" }, { "name": "limit", "value": "", "type": "query" }, { "name": "prefix", "value": "", "type": "query" }, { "name": "cursor", "value": "", "type": "query" } ] }, "docs": "Lists a namespace's keys." }, { "info": { "name": "APIs.io Engineering Platform Read the metadata for a key", "type": "http" }, "http": { "method": "GET", "url": "http://apigateway.{region}.amazonaws.com/accounts/:account_id/storage/kv/namespaces/:namespace_id/metadata/:key_name", "params": [ { "name": "key_name", "value": "", "type": "path" }, { "name": "namespace_id", "value": "", "type": "path" }, { "name": "account_id", "value": "", "type": "path" } ] }, "docs": "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." }, { "info": { "name": "APIs.io Engineering Platform Read key-value pair", "type": "http" }, "http": { "method": "GET", "url": "http://apigateway.{region}.amazonaws.com/accounts/:account_id/storage/kv/namespaces/:namespace_id/values/:key_name", "params": [ { "name": "key_name", "value": "", "type": "path" }, { "name": "namespace_id", "value": "", "type": "path" }, { "name": "account_id", "value": "", "type": "path" } ] }, "docs": "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." }, { "info": { "name": "APIs.io Engineering Platform Write key-value pair with metadata", "type": "http" }, "http": { "method": "PUT", "url": "http://apigateway.{region}.amazonaws.com/accounts/:account_id/storage/kv/namespaces/:namespace_id/values/:key_name", "params": [ { "name": "key_name", "value": "", "type": "path" }, { "name": "namespace_id", "value": "", "type": "path" }, { "name": "account_id", "value": "", "type": "path" } ], "body": { "type": "multipart-form", "data": [ { "name": "metadata", "type": "text", "value": "" }, { "name": "value", "type": "text", "value": "" } ] } }, "docs": "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." }, { "info": { "name": "APIs.io Engineering Platform Delete key-value pair", "type": "http" }, "http": { "method": "DELETE", "url": "http://apigateway.{region}.amazonaws.com/accounts/:account_id/storage/kv/namespaces/:namespace_id/values/:key_name", "params": [ { "name": "key_name", "value": "", "type": "path" }, { "name": "namespace_id", "value": "", "type": "path" }, { "name": "account_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Remove a KV pair from the namespace. Use URL-encoding to use special characters (for example, `:`, `!`, `%`) in the key name." } ] } ], "bundled": true }