Skip to content
Console
On this page

Hash set in KV

Sets fields of a hash (HSET), creating it.

Sets fields of a hash (HSET), creating it.

  • Path POST https://api.data.sylphx.com/v1/kv-hashes
  • Scope data:write
  • Effect write — a successful call changes state.
  • Collection kv
  • Host https://api.data.sylphx.com

Request

FieldTypeWhat it is
namespace_idstringThe namespace's id. Required.
keystringThe hash's key. Required.
fieldsHashField[]The fields to set; at least one. Required.

HashField

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

Response

FieldTypeWhat it is
addeduint64How many fields were new.
versionuint64The hash's version after the write.

Errors

Every error arrives in the body Errors describes.

Examples

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