Skip to content
Cloudflare API
Start here
API Reference

KV

KVNamespaces

List Namespaces
client.KV.Namespaces.List(ctx, params) (*V4PagePaginationArray[Namespace], error)
GET/accounts/{account_id}/storage/kv/namespaces
Get a Namespace
client.KV.Namespaces.Get(ctx, namespaceID, query) (*Namespace, error)
GET/accounts/{account_id}/storage/kv/namespaces/{namespace_id}
Create a Namespace
client.KV.Namespaces.New(ctx, params) (*Namespace, error)
POST/accounts/{account_id}/storage/kv/namespaces
Rename a Namespace
client.KV.Namespaces.Update(ctx, namespaceID, params) (*Namespace, error)
PUT/accounts/{account_id}/storage/kv/namespaces/{namespace_id}
Remove a Namespace
client.KV.Namespaces.Delete(ctx, namespaceID, body) (*NamespaceDeleteResponse, error)
DELETE/accounts/{account_id}/storage/kv/namespaces/{namespace_id}
Write multiple key-value pairs
client.KV.Namespaces.BulkUpdate(ctx, namespaceID, params) (*NamespaceBulkUpdateResponse, error)
PUT/accounts/{account_id}/storage/kv/namespaces/{namespace_id}/bulk
Delete multiple key-value pairs
client.KV.Namespaces.BulkDelete(ctx, namespaceID, params) (*NamespaceBulkDeleteResponse, error)
POST/accounts/{account_id}/storage/kv/namespaces/{namespace_id}/bulk/delete
Get multiple key-value pairs
client.KV.Namespaces.BulkGet(ctx, namespaceID, params) (*NamespaceBulkGetResponse, error)
POST/accounts/{account_id}/storage/kv/namespaces/{namespace_id}/bulk/get
ModelsExpand Collapse
type Namespace struct{…}
ID string

Namespace identifier tag.

maxLength32
Title string

A human-readable string name for a Namespace.

maxLength512
SupportsURLEncoding booloptional

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 "?".

KVNamespacesKeys

List a Namespace's Keys
client.KV.Namespaces.Keys.List(ctx, namespaceID, params) (*CursorLimitPagination[Key], error)
GET/accounts/{account_id}/storage/kv/namespaces/{namespace_id}/keys
Write multiple key-value pairs
Deprecated
client.KV.Namespaces.Keys.BulkUpdate(ctx, namespaceID, params) (*NamespaceKeyBulkUpdateResponse, error)
PUT/accounts/{account_id}/storage/kv/namespaces/{namespace_id}/bulk
Delete multiple key-value pairs
Deprecated
client.KV.Namespaces.Keys.BulkDelete(ctx, namespaceID, params) (*NamespaceKeyBulkDeleteResponse, error)
POST/accounts/{account_id}/storage/kv/namespaces/{namespace_id}/bulk/delete
Get multiple key-value pairs
Deprecated
client.KV.Namespaces.Keys.BulkGet(ctx, namespaceID, params) (*NamespaceKeyBulkGetResponse, error)
POST/accounts/{account_id}/storage/kv/namespaces/{namespace_id}/bulk/get
ModelsExpand Collapse
type Key struct{…}

A name for a value. A value stored under a given key may be retrieved via the same 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.

maxLength512
Expiration float64optional

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.

Metadata unknownoptional

Arbitrary JSON that is associated with a key.

KVNamespacesMetadata

Read the metadata for a key
client.KV.Namespaces.Metadata.Get(ctx, namespaceID, keyName, query) (*NamespaceMetadataGetResponse, error)
GET/accounts/{account_id}/storage/kv/namespaces/{namespace_id}/metadata/{key_name}

KVNamespacesValues

Read key-value pair
client.KV.Namespaces.Values.Get(ctx, namespaceID, keyName, query) (*Response, error)
GET/accounts/{account_id}/storage/kv/namespaces/{namespace_id}/values/{key_name}
Write key-value pair with optional metadata
client.KV.Namespaces.Values.Update(ctx, namespaceID, keyName, params) (*NamespaceValueUpdateResponse, error)
PUT/accounts/{account_id}/storage/kv/namespaces/{namespace_id}/values/{key_name}
Delete key-value pair
client.KV.Namespaces.Values.Delete(ctx, namespaceID, keyName, body) (*NamespaceValueDeleteResponse, error)
DELETE/accounts/{account_id}/storage/kv/namespaces/{namespace_id}/values/{key_name}