Write multiple key-value pairs

PUT

https://api.cloudflare.com/client/v4/accounts/{account_identifier}/storage/kv/namespaces/{namespace_identifier}/bulk

Last modified:2022-12-16 13:48:35

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.

Request

Path Params

namespace_identifier

string

required

account_identifier

string

required

Body Params application/json

array of:

base64

boolean

optional

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.

Default:

false

expiration

number

optional

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

Example:

1578435000

expiration_ttl

number

optional

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

Example:

300

key

string

optional

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

<= 512 characters

Example:

My-Key

metadata

object (list_metadata)

optional

Arbitrary JSON that is associated with a key.

Example:

{"someMetadataKey":"someMetadataValue"}

value

string

optional

A UTF-8 encoded string to be stored, up to 10 MB in length.

<= 10485760 characters

Example:

Some string

Example

[
    {
        "base64": false,
        "expiration": 1578435000,
        "expiration_ttl": 300,
        "key": "My-Key",
        "metadata": {
            "someMetadataKey": "someMetadataValue"
        },
        "value": "Some string"
    }
]

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request PUT 'https://api.cloudflare.com/client/v4/accounts//storage/kv/namespaces//bulk' \
--header 'Content-Type: application/json' \
--data-raw '[
    {
        "base64": false,
        "expiration": 1578435000,
        "expiration_ttl": 300,
        "key": "My-Key",
        "metadata": {
            "someMetadataKey": "someMetadataValue"
        },
        "value": "Some string"
    }
]'

Responses

🟢200Write multiple key-value pairs response

application/json

Body

errors

array [object {2}]

messages

required

Example:

[]

code

integer

required

>= 1000

message

string

required

messages

array [object {2}]

messages

required

Example:

[]

code

integer

required

>= 1000

message

string

required

result

required

Any of

allOf {2}

One of

null

object

success

enum<boolean>

required

Whether the API call was successful

Allowed value:

true

Example:

true

Example

{
    "errors": [],
    "messages": [],
    "result": {},
    "success": true
}

🟢200Write multiple key-value pairs response failure

Modified at 2022-12-16 13:48:35

Delete multiple key-value pairs

List a Namespace's Keys