Using
Lists one page of keys in the domain, optionally filtered by a prefix and/or a case-sensitive `contains` substring. `total` counts matches after filtering, before `offset`/`limit` are applied; an out-of-range `offset` yields an empty `keys` array with `total` unchanged.
applies to v0.5.1GET
/store-api/kv/{domain}/keys
const url = 'https://example.com/store-api/kv/example/keys';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 \ --header 'Authorization: Bearer <token>'Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”domain
required
string
Domain name
Query Parameters
Section titled “Query Parameters”prefix
string
Key prefix filter
contains
string
Case-sensitive substring filter on the user key, applied before total/offset/limit
limit
integer
Page size (default 1000, max 10000; over-max is silently capped)
offset
integer
Keys to skip
Responses
Section titled “Responses”One page of matching keys
Media typeapplication/json
object
keys
required
The page, in scan order (sorted).
Array<string>
limit
required
Effective limit applied (after capping to the maximum).
integer
offset
required
Effective offset applied.
integer
total
required
Matches after prefix/contains filtering, before offset/limit.
integer format: int64
Example generated
{ "keys": [ "example" ], "limit": 1, "offset": 1, "total": 1}Domain is being deleted
Media typetext/plain
string
Rate limit exceeded
Media typetext/plain
string
Headers
Section titled “Headers”Retry-After
integer format: int64