Using

Sets the key to an explicit null value (upsert): the key stays registered and appears in scans, but carries no data — GET answers 204. A write like any other; it resets a previously set TTL, and takes the same `If-Match` / `If-None-Match: *` preconditions as PUT.

applies to v0.5.1

PATCH

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

const url = 'https://example.com/store-api/kv/example/keys/example/null';
const options = {method: 'PATCH', 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 PATCH \
  --url https://example.com/store-api/kv/example/keys/example/null \
  --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)

Header Parameters

If-Match

string | null

ETag from a prior read: write only if it is still the key’s current version, else 412

If-None-Match

string | null

Only *: write only if the key does not exist, else 412. Evaluated after If-Match

Responses

200

Key set to the null value state

400

Invalid key, or invalid If-Match / If-None-Match header

text/plain

string

410

Domain is being deleted

text/plain

string

412

If-Match or If-None-Match does not hold; nothing was written

text/plain

string

Headers

ETag

string

ETag of the key’s current version; absent when the key does not exist

428

The domain requires conditional writes and neither If-Match nor If-None-Match is set

text/plain

string

Headers

Cache-Control

string

No-store

429

Rate limit exceeded

text/plain

string

Headers

Retry-After

integer format: int64

507

Insufficient Storage — disk space or memory runs short; the write was not applied. Reads go on; retry after the seconds in Retry-After.

text/plain

string

Headers

Retry-After

integer