Menu
Platform
AI
App store purchases
Database
Flags
Jobs and cron
Localization
Monitoring
Notifications
Payments
Queues
Sandboxes
Webhooks
Getting Started
Authentication
KV Store
Deploy & Infrastructure
Reference
KV
The `kv` collection of Sylphx Data.
The kv collection of Sylphx Data — served at https://api.data.sylphx.com.
Service Sylphx Data · served at https://api.data.sylphx.com
#Methods
Every method of the collection, in the registry's order, with the scope it needs. The full request, response and examples are one link away.
| Method | Call | What it does |
|---|---|---|
PUT | put | Writes a value. Without ttl_seconds the namespace default applies; zero means no expiry. |
GET | get | Reads a value. |
GET | list | Lists a namespace's values in key order. |
DELETE | delete | Deletes a value. |
POST | increment | Adds delta (default 1) to an integer value, creating it at zero. |
POST | get_many | Reads up to 1000 keys at once (MGET). Answers one entry per key, in order; an absent or expired key keeps its key and has no value. |
POST | hash_set | Sets fields of a hash (HSET), creating it. |
POST | hash_get | Reads one field of a hash (HGET); an absent field has no value. |
POST | hash_get_all | Reads every field of a hash (HGETALL). |
POST | hash_get_many | Reads several fields of a hash (HMGET), one per field, in order; an absent field has no value. |
POST | list_push | Pushes values onto the head of a list (LPUSH), creating it. |
POST | list_range | Reads a range of a list (LRANGE); negative indexes count from the end. |
POST | list_pop | Pops values from the head of a list (LPOP); an emptied list is removed. |
POST | list_length | Reads the length of a list (LLEN); an absent key has length zero. |
POST | zset_add | Adds members to a sorted set or updates their scores (ZADD), creating it. |
POST | zset_range | Reads a range of a sorted set by rank, lowest score first (ZRANGE); negative indexes count from the end. |
POST | zset_score | Reads a member's score (ZSCORE); an absent member has no score. |
POST | zset_length | Reads the size of a sorted set (ZCARD); an absent key has size zero. |
POST | scan | Walks a namespace's keys that match a glob (SCAN). Call again with the returned cursor until it is empty. |
POST | expire | Sets a key's time to live (EXPIRE) without rewriting its value; zero makes it persistent. |
#put
Writes a value. Without ttl_seconds the namespace default applies; zero means no expiry.
PUT https://api.data.sylphx.com/v1/kv/namespace-id/key · scope data:write · effect write · Request, response and examples
#get
Reads a value.
GET https://api.data.sylphx.com/v1/kv/namespace-id/key · scope data:read · effect read · Request, response and examples
#list
Lists a namespace's values in key order.
GET https://api.data.sylphx.com/v1/kv/namespace-id · scope data:read · effect read · Request, response and examples
#delete
Deletes a value.
DELETE https://api.data.sylphx.com/v1/kv/namespace-id/key · scope data:write · effect destructive · Request, response and examples
#increment
Adds delta (default 1) to an integer value, creating it at zero.
POST https://api.data.sylphx.com/v1/kv-increments · scope data:write · effect write · Request, response and examples
#get_many
Reads up to 1000 keys at once (MGET). Answers one entry per key, in order; an absent or expired key keeps its key and has no value.
POST https://api.data.sylphx.com/v1/kv-mget · scope data:read · effect read · Request, response and examples
#hash_set
Sets fields of a hash (HSET), creating it.
POST https://api.data.sylphx.com/v1/kv-hashes · scope data:write · effect write · Request, response and examples
#hash_get
Reads one field of a hash (HGET); an absent field has no value.
POST https://api.data.sylphx.com/v1/kv-hash-gets · scope data:read · effect read · Request, response and examples
#hash_get_all
Reads every field of a hash (HGETALL).
POST https://api.data.sylphx.com/v1/kv-hash-getall · scope data:read · effect read · Request, response and examples
#hash_get_many
Reads several fields of a hash (HMGET), one per field, in order; an absent field has no value.
POST https://api.data.sylphx.com/v1/kv-hash-mget · scope data:read · effect read · Request, response and examples
#list_push
Pushes values onto the head of a list (LPUSH), creating it.
POST https://api.data.sylphx.com/v1/kv-list-pushes · scope data:write · effect write · Request, response and examples
#list_range
Reads a range of a list (LRANGE); negative indexes count from the end.
POST https://api.data.sylphx.com/v1/kv-list-ranges · scope data:read · effect read · Request, response and examples
#list_pop
Pops values from the head of a list (LPOP); an emptied list is removed.
POST https://api.data.sylphx.com/v1/kv-list-pops · scope data:write · effect write · Request, response and examples
#list_length
Reads the length of a list (LLEN); an absent key has length zero.
POST https://api.data.sylphx.com/v1/kv-list-lens · scope data:read · effect read · Request, response and examples
#zset_add
Adds members to a sorted set or updates their scores (ZADD), creating it.
POST https://api.data.sylphx.com/v1/kv-zsets · scope data:write · effect write · Request, response and examples
#zset_range
Reads a range of a sorted set by rank, lowest score first (ZRANGE); negative indexes count from the end.
POST https://api.data.sylphx.com/v1/kv-zset-ranges · scope data:read · effect read · Request, response and examples
#zset_score
Reads a member's score (ZSCORE); an absent member has no score.
POST https://api.data.sylphx.com/v1/kv-zset-scores · scope data:read · effect read · Request, response and examples
#zset_length
Reads the size of a sorted set (ZCARD); an absent key has size zero.
POST https://api.data.sylphx.com/v1/kv-zset-lens · scope data:read · effect read · Request, response and examples
#scan
Walks a namespace's keys that match a glob (SCAN). Call again with the returned cursor until it is empty.
POST https://api.data.sylphx.com/v1/kv-scans · scope data:read · effect read · Request, response and examples
#expire
Sets a key's time to live (EXPIRE) without rewriting its value; zero makes it persistent.
POST https://api.data.sylphx.com/v1/kv-expiries · scope data:write · effect write · Request, response and examples