Write multiple key-value pairs

client.kv.namespaces.bulkUpdate(, , ?): NamespaceBulkUpdateResponse { successful_key_count, unsuccessful_keys } | null

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

Writes up to 10,000 key-value pairs to the specified Workers KV namespace from a JSON array, with optional metadata and expiration settings for each pair. Existing values and expirations are overwritten. If neither expiration nor expiration_ttl is specified, the key-value pair will not expire. If both are set, expiration_ttl takes precedence. The entire request must be 100 megabytes or less. The result reports the number of successful writes and any keys that failed and should be retried.

Security

API Token

The preferred authorization scheme for interacting with the Cloudflare API. Create a token.

Example:Authorization: Bearer Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY

API Email + API Key

The previous authorization scheme for interacting with the Cloudflare API, used in conjunction with a Global API key.

Example:X-Auth-Email: user@example.com

The previous authorization scheme for interacting with the Cloudflare API. When possible, use API tokens instead of Global API keys.

Example:X-Auth-Key: 144c9defac04969c7bfad8efaa8ea194

Accepted Permissions (at least one required)

Workers KV Storage Write

ParametersExpand Collapse

namespaceID: string

ID of the Workers KV namespace.

maxLength32

params: NamespaceBulkUpdateParams { account_id, body }

account_id: string

Path param: ID of the Cloudflare account that owns the Workers KV namespaces.

maxLength32

body: Array<Body>

Body param

key: string

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

maxLength512

value: string

A UTF-8 encoded string to be stored, up to 25 MiB in length.

maxLength26214400

base64?: boolean

Indicates 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.

expiration?: number

Expires the key at a certain time, measured in number of seconds since the UNIX epoch.

expiration_ttl?: number

Number of seconds until the key expires. Must be at least 60. Takes precedence over expiration when both are specified.

minimum60

metadata?: unknown

Arbitrary JSON that is associated with a key.

ReturnsExpand Collapse

NamespaceBulkUpdateResponse { successful_key_count, unsuccessful_keys }

successful_key_count?: number

Number of keys successfully written or deleted by the bulk operation.

unsuccessful_keys?: Array<string>

Names of keys that failed to be written or deleted. Retry the operation for these keys.

Write multiple key-value pairs

import Cloudflare from 'cloudflare';

const client = new Cloudflare({
  apiToken: process.env['CLOUDFLARE_API_TOKEN'], // This is the default and can be omitted
});

const response = await client.kv.namespaces.bulkUpdate('0f2ac74b498b48028cb68387c421e279', {
  account_id: '023e105f4ecef8ad9ca31a8372d0c353',
  body: [{ key: 'My-Key', value: 'Some string' }],
});

console.log(response.successful_key_count);

{
  "errors": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "messages": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "success": true,
  "result": {
    "successful_key_count": 100,
    "unsuccessful_keys": [
      "string"
    ]
  }
}

Returns Examples

{
  "errors": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "messages": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "success": true,
  "result": {
    "successful_key_count": 100,
    "unsuccessful_keys": [
      "string"
    ]
  }
}