Using

Retrieves the raw byte value for a key. Returns 204 for a key in the null state and 404 if the key does not exist or has expired. When the key has a TTL, the response carries an `X-Expires-At` header with the absolute Unix-seconds expiry. 200 and 204 carry an `ETag` identifying the version read, for a later conditional write.

applies to v0.5.1

GET

/store-api/kv/{domain}/keys/{key}

const url = 'https://example.com/store-api/kv/example/keys/example';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://example.com/store-api/kv/example/keys/example \
  --header 'Authorization: Bearer <token>'

Authorizations

bearer_auth

Parameters

Path Parameters

domain

required

string

Domain name

key

required

string

Key (valid UTF-8, max 256 bytes)

Responses

200

Value (raw bytes; an empty value yields an empty body). The X-Expires-At header (absolute Unix seconds) is present only when the key has a TTL.

application/octet-stream

Headers

ETag

string

Strong, opaque version tag for If-Match / If-None-Match

X-Expires-At

integer format: int64

204

Key exists in the explicit null state (set via PATCH …/null)

Headers

ETag

string

Strong, opaque version tag for If-Match / If-None-Match

400

Invalid key

text/plain

string

404

Key or domain not found

text/plain

string

410

Domain is being deleted

text/plain

string

429

Rate limit exceeded

text/plain

string

Headers

Retry-After

integer format: int64