Key-Value API

Key-value store

REST API endpoints for Key-Value. 5 operations.

Delete keys

POST /v1/kv/del

Removes one or more keys from the tenant's key-value store (batch delete).

Auth: Bearer API key

Request body

application/json (required) — schema KvDelRequest.

Responses

operationId: kvDel

Check if a key exists

POST /v1/kv/exists

Returns whether a key is present in the tenant's key-value store.

Auth: Bearer API key

Request body

application/json (required) — schema KvKeyRequest.

Responses

operationId: kvExists

Fetch a value by key

POST /v1/kv/get

Reads a single key from the tenant's key-value store; returns value: null if absent.

Auth: Bearer API key

Request body

application/json (required) — schema KvKeyRequest.

Responses

operationId: kvGet

List keys

POST /v1/kv/keys

Returns the keys in the tenant's key-value store matching an optional glob pattern.

Auth: Bearer API key

Request body

application/json (required) — schema KvKeysRequest.

Responses

operationId: kvKeys

Set a value by key

POST /v1/kv/set

Writes a value to the tenant's key-value store, with an optional TTL.

Auth: Bearer API key

Request body

application/json (required) — schema KvSetRequest.

Responses

operationId: kvSet