Skip to content
Console
Menu

Queues

Workflows

Getting Started

Authentication

KV Store

Get in KV

Reads a value.

Reads a value.

  • Path GET https://api.data.sylphx.com/v1/kv/namespace-id/key
  • Scope data:read
  • Effect read — nothing is written.
  • Collection kv
  • Host https://api.data.sylphx.com

#Request

FieldTypeWhat it is
namespace_idstringThe namespace's id. Required.
keystringThe key. Required.

#Response

FieldTypeWhat it is
valueValueRecordThe entry.

#ValueRecord

FieldTypeWhat it is
namespace_idstringThe namespace's id in the environment, for example ratelimit.
keystringThe key.
valuebytesThe bytes, base64.
sha256stringsha256:<hex> of the value.
versionuint64The version, increasing per key.
expires_at_unix_msint64Expiry in Unix milliseconds; zero never expires.
updated_at_unix_msint64When this version was written, in Unix milliseconds.

#Errors

Every error arrives in the body Errors describes.

#Examples

curl "https://api.data.sylphx.com/v1/kv/namespace-id/key" \
  -H "Authorization: Bearer $SYLPHX_API_KEY"