Skip to content
Console
On this page

Hash get all in KV

Reads every field of a hash (HGETALL).

Reads every field of a hash (HGETALL).

  • Path POST https://api.data.sylphx.com/v1/kv-hash-getall
  • 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 hash's key. Required.

Response

FieldTypeWhat it is
fieldsHashField[]Every field of the hash; empty when the hash is absent.

HashField

FieldTypeWhat it is
fieldstringThe field's name. Required.
valuebytesThe bytes, base64; unset when the field is absent.

Errors

Every error arrives in the body Errors describes.

Examples

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