Scan in KV

Walks a namespace's keys that match a glob (SCAN).

Checked 2026-09-28

Walks a namespace's keys that match a glob (SCAN). Call again with the returned cursor until it is empty.

Path POST https://api.data.sylphx.com/v1/kv-scans
Scope data:read
Effect read — nothing is written.
Collection kv
Host https://api.data.sylphx.com

#Request

Field	Type	What it is
`namespace_id`	`string`	The namespace's id. Required.
`glob`	`string`	A glob of the keys to answer (`*`, `?`, `\` escapes); empty matches every key.
`cursor`	`string`	The `cursor` of the previous call; empty starts the walk.
`count`	`uint32`	At most this many keys per call; the service caps it at 1000.

#Response

Field	Type	What it is
`keys`	`string[]`	The matching keys of this step.
`cursor`	`string`	Pass to the next call; empty when the walk is done.

#Errors

UNAUTHENTICATED — No valid key or token was presented.
PERMISSION_DENIED — The key lacks the method's permission.
INVALID_FIELD — A field failed validation.
RESOURCE_NOT_FOUND — The named Resource does not exist or is not visible.

Every error arrives in the body Errors describes.

#Examples

curl -X POST "https://api.data.sylphx.com/v1/kv-scans" \
  -H "Authorization: Bearer $SYLPHX_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"namespace_id":"…"}'

Was this page helpful?

Tell us what is missing, wrong, or unclear — this opens a real inbox.

Send feedback

Platform links