APIs.io Engineering Platform Workers KV Namespace API

The Workers KV Namespace API from APIs.io Engineering Platform — 7 operation(s) for workers kv namespace.

Documentation Provider Profile APIs.io OpenAPI GitHub

This API exposes 13 operations across 7 paths, and defines 22 schemas. It is described by OpenAPI 3.0.0, at version 2015-07-09.

Requests are made against 4 base URLs: http://apigateway.{region}.amazonaws.com, https://apigateway.{region}.amazonaws.com, http://apigateway.{region}.amazonaws.com.cn, https://apigateway.{region}.amazonaws.com.cn.

13 operations 7 paths 22 schemas 3 DELETE5 GET2 POST3 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification

OpenAPI 3.0.0

API Version

2015-07-09

Base URL

https://{bucketname}.s3.amazonaws.com

Authentication

API Key

Contact

Mike Ralphson

License

Apache 2.0 License

View terms

Resource Areas

Authentication & Security 1

APIs.io Engineering Platform Workers KV Namespace API declares 1 security scheme for authenticating requests. An API key is passed in the header as Authorization (hmac). By default, every request must be authenticated.

hmac — Amazon Signature authorization v4

Paths & Operations 13

Across 7 paths, the API surfaces 13 operations — 3 DELETE, 5 GET, 2 POST, 3 PUT. Each is listed below with its method, path, parameters, and response codes.

Workers KV Namespace 13

GET

/accounts/{account_id}/storage/kv/namespaces

APIs.io Engineering Platform List Namespaces

workers-kv-namespace-list-namespaces 5 params → 4XX200

POST

/accounts/{account_id}/storage/kv/namespaces

APIs.io Engineering Platform Create a Namespace

workers-kv-namespace-create-a-namespace 1 param body → 4XX200

DELETE

/accounts/{account_id}/storage/kv/namespaces/{namespace_id}

APIs.io Engineering Platform Remove a Namespace

workers-kv-namespace-remove-a-namespace 2 params body → 4XX200

GET

/accounts/{account_id}/storage/kv/namespaces/{namespace_id}

APIs.io Engineering Platform Get a Namespace

workers-kv-namespace-get-a-namespace 2 params → 4XX200

PUT

/accounts/{account_id}/storage/kv/namespaces/{namespace_id}

APIs.io Engineering Platform Rename a Namespace

workers-kv-namespace-rename-a-namespace 2 params body → 4XX200

DELETE

/accounts/{account_id}/storage/kv/namespaces/{namespace_id}/bulkdeprecated

APIs.io Engineering Platform Delete multiple key-value pairs

workers-kv-namespace-delete-multiple-key-value-pairs-deprecated 2 params body → 4XX200

PUT

/accounts/{account_id}/storage/kv/namespaces/{namespace_id}/bulk

APIs.io Engineering Platform Write multiple key-value pairs

workers-kv-namespace-write-multiple-key-value-pairs 2 params body → 4XX200

POST

/accounts/{account_id}/storage/kv/namespaces/{namespace_id}/bulk/delete

APIs.io Engineering Platform Delete multiple key-value pairs

workers-kv-namespace-delete-multiple-key-value-pairs 2 params body → 4XX200

GET

/accounts/{account_id}/storage/kv/namespaces/{namespace_id}/keys

APIs.io Engineering Platform List a Namespace's Keys

workers-kv-namespace-list-a-namespace'-s-keys 5 params → 4XX200

GET

/accounts/{account_id}/storage/kv/namespaces/{namespace_id}/metadata/{key_name}

APIs.io Engineering Platform Read the metadata for a key

workers-kv-namespace-read-the-metadata-for-a-key 3 params → 4XX200

DELETE

/accounts/{account_id}/storage/kv/namespaces/{namespace_id}/values/{key_name}

APIs.io Engineering Platform Delete key-value pair

workers-kv-namespace-delete-key-value-pair 3 params body → 4XX200

GET

/accounts/{account_id}/storage/kv/namespaces/{namespace_id}/values/{key_name}

APIs.io Engineering Platform Read key-value pair

workers-kv-namespace-read-key-value-pair 3 params → 4XX200

PUT

/accounts/{account_id}/storage/kv/namespaces/{namespace_id}/values/{key_name}

APIs.io Engineering Platform Write key-value pair with metadata

workers-kv-namespace-write-key-value-pair-with-metadata 3 params body → 4XX200

Schemas 22

The contract defines 22 schemas that model the data the API accepts and returns. The most detailed are workers-kv_result_info (4 properties), workers-kv_api-response-common-failure (4 properties), workers-kv_api-response-common (3 properties), workers-kv_namespace (3 properties). Each schema is shown below with its type and property counts.

workers-kv_namespace

object

3 properties 2 required

workers-kv_api-response-common-no-result

workers-kv_namespace_title

string

A human-readable string name for a Namespace.

workers-kv_create_rename_namespace_body

object

1 property 1 required

workers-kv_metadata

string

Arbitrary JSON to be associated with a key/value pair.

workers-kv_expiration_ttl

number

The number of seconds for which the key should be visible before it expires. At least 60.

workers-kv_cursor

string

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 para…

workers-kv_key_name

string

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.

workers-kv_identifier

string

Identifier

workers-kv_value

string

A byte sequence to be stored, up to 25 MiB in length.

workers-kv_result_info

object

4 properties

workers-kv_key

object

A name for a value. A value stored under a given key may be retrieved via the same key.

3 properties 1 required

workers-kv_key_name_bulk

string

A key's name. The name may be at most 512 bytes. All printable, non-whitespace characters are valid.

workers-kv_list_metadata

object

Arbitrary JSON that is associated with a key.

workers-kv_api-response-common

object

3 properties 3 required

workers-kv_api-response-collection

object

workers-kv_api-response-common-failure

object

4 properties 4 required

workers-kv_expiration

number

The time, measured in number of seconds since the UNIX epoch, at which the key should expire.

workers-kv_namespace_identifier

string

Namespace identifier tag.

workers-kv_messages

array

workers-kv_bulk_write

array

2 required

workers-kv_bulk_delete

array

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

#Workers KV Namespace

← Back to A APIs

Discovery

Learnings

Guidance

Toolbox

Alignment

API Evangelist LLC

APIs.io Engineering Platform Workers KV Namespace API

Metadata

Authentication & Security 1

Paths & Operations 13

Schemas 22

Specification

Source

API Details

Provider

Explore more