Read a KV key

GET

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

curl --request GET \
  --url 'https://digize.com/api/v1/storage/kv/example/value?key=example' \
  --header 'x-api-key: <x-api-key>'

• Digize

A key’s value, as text unless it’s binary, with its metadata and expiry. Null if there’s no such key.

Needs the sites:read permission.

Authorizations

• apiKey
• bearer

Parameters

Path Parameters

namespace

required

string

>= 1 characters <= 100 characters

Query Parameters

key

required

string

>= 1 characters <= 512 characters

Responses

200

Done

Media typeapplication/json

Any of:

object

object

value

required

string | null

size

required

number

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

null

null

Example ^generated

{
  "value": "example",
  "size": 1,
  "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"
  }
}

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"
  }
}