Write a KV key

PUT

/api/v1/storage/kv/{namespace}/value

curl --request PUT \
  --url https://digize.com/api/v1/storage/kv/example/value \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: 5f1c2a8e-3b7d-4c55-9a0e-1f2d3c4b5a69' \
  --header 'x-api-key: <x-api-key>' \
  --data '{ "key": "example", "value": "example", "metadata": { "additionalProperty": "example" }, "expirationTtl": 1 }'

• Digize

Writes a key’s value, with optional JSON metadata and an expiry in seconds from now (at least 60). Workers see it within 60 seconds.

Needs the sites:write permission.

Authorizations

• apiKey
• bearer

Parameters

Path Parameters

namespace

required

string

>= 1 characters <= 100 characters

Header Parameters

Idempotency-Key

string

>= 1 characters <= 255 characters

Makes the request safe to send again: for 24 hours the same key and request answer the first response without repeating the change.

Example

5f1c2a8e-3b7d-4c55-9a0e-1f2d3c4b5a69

Request Body^required

Media typeapplication/json

object

key

required

string

>= 1 characters <= 512 characters

value

required

string

<= 26214400 characters

metadata

Any of:

object

object

key

additional properties

string | number | boolean

null

null

expirationTtl

Any of:

integer

integer

>= 60 <= 9007199254740991

null

null

Example ^generated

{
  "key": "example",
  "value": "example",
  "metadata": {
    "additionalProperty": "example"
  },
  "expirationTtl": 1
}

Responses

200

Done

Media typeapplication/json

object

name

required

string

metadata

required

Any of:

object

object

key

additional properties

string | number | boolean

null

null

expiration

required

Any of:

string

string format: date-time

null

null

Example ^generated

{
  "name": "example",
  "metadata": {
    "additionalProperty": "example"
  },
  "expiration": "2026-04-15T12:00:00Z"
}

400

What was sent isn’t valid (invalid).

Media typeapplication/json

object

error

required

object

code

required

string

Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal

message

required

string

details

object

key

additional properties

any

Example

{
  "error": {
    "code": "invalid"
  }
}

401

No key, or one that’s unknown, off or expired.

Media typeapplication/json

object

error

required

object

code

required

string

Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal

message

required

string

details

object

key

additional properties

any

Example

{
  "error": {
    "code": "invalid"
  }
}

403

The key doesn’t have the permission this needs.

Media typeapplication/json

object

error

required

object

code

required

string

Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal

message

required

string

details

object

key

additional properties

any

Example

{
  "error": {
    "code": "invalid"
  }
}

404

Nothing has that id (not_found).

Media typeapplication/json

object

error

required

object

code

required

string

Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal

message

required

string

details

object

key

additional properties

any

Example

{
  "error": {
    "code": "invalid"
  }
}

409

A request with the same Idempotency-Key is still running (conflict).

Media typeapplication/json

object

error

required

object

code

required

string

Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal

message

required

string

details

object

key

additional properties

any

Example

{
  "error": {
    "code": "invalid"
  }
}

422

The Idempotency-Key was used with a different request.

Media typeapplication/json

object

error

required

object

code

required

string

Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal

message

required

string

details

object

key

additional properties

any

Example

{
  "error": {
    "code": "invalid"
  }
}

429

Over the rate limit; see retry-after.

Media typeapplication/json

object

error

required

object

code

required

string

Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal

message

required

string

details

object

key

additional properties

any

Example

{
  "error": {
    "code": "invalid"
  }
}