KV
KV
Namespaces
KV.Namespaces
Methods
Returns the namespaces owned by an account.
Get the namespace corresponding to the given ID.
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.
Modifies a namespace's title.
Deletes the namespace corresponding to the given ID.
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.
Remove multiple KV pairs from the namespace. Body should be an array of up to 10,000 keys to be removed.
Retrieve up to 100 KV pairs from the namespace. Keys must contain text-based values. JSON values can optionally be parsed instead of being returned as a string value. Metadata can be included if withMetadata is true.
Domain types
KV.Namespaces.Keys
Methods
Lists a namespace's keys.
Deprecated
Please use kv.namespaces.bulk_update instead
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.
Deprecated
Please use kv.namespaces.bulk_delete instead
Remove multiple KV pairs from the namespace. Body should be an array of up to 10,000 keys to be removed.
Deprecated
Please use kv.namespaces.bulk_get instead
Retrieve up to 100 KV pairs from the namespace. Keys must contain text-based values. JSON values can optionally be parsed instead of being returned as a string value. Metadata can be included if withMetadata is true.
Domain types
A name for a value. A value stored under a given key may be retrieved via the same key.
KV.Namespaces.Metadata
Methods
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.
KV.Namespaces.Values
Methods
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.
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. If JSON metadata to be associated with the key/value pair is needed, use multipart/form-data content type for your PUT request (see dropdown below in REQUEST BODY SCHEMA). 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.
Remove a KV pair from the namespace. Use URL-encoding to use special characters (for example, :, !, %) in the key name.