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
List pop in KV
Pops values from the head of a list (LPOP); an emptied list is removed.
Pops values from the head of a list (LPOP); an emptied list is removed.
- Path
POST https://api.data.sylphx.com/v1/kv-list-pops - Scope
data:write - Effect
write— a successful call changes state. - Collection kv
- Host
https://api.data.sylphx.com
#Request
| Field | Type | What it is |
|---|---|---|
namespace_id | string | The namespace's id. Required. |
key | string | The list's key. Required. |
count | uint64 | How many values to pop; unset pops one, zero pops none. |
#Response
| Field | Type | What it is |
|---|---|---|
values | bytes[] | The popped values, each base64, head first. |
length | uint64 | The list's length after the pop. |
version | uint64 | The list's version after the pop. |
#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-list-pops" \
-H "Authorization: Bearer $SYLPHX_API_KEY" \
-H "Content-Type: application/json" \
-d '{"key":"…","namespace_id":"…"}'