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
On this page
Increment in KV
Adds `delta` (default 1) to an integer value, creating it at zero.
Adds delta (default 1) to an integer value, creating it at zero.
- Path
POST https://api.data.sylphx.com/v1/kv-increments - 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 key. Required. |
delta | int64 | The amount to add; unset adds 1, and zero reads the count. |
#Response
| Field | Type | What it is |
|---|---|---|
value | ValueRecord | The entry after the increment; value is the decimal text of the count. |
#ValueRecord
| Field | Type | What it is |
|---|---|---|
namespace_id | string | The namespace's id in the environment, for example ratelimit. |
key | string | The key. |
value | bytes | The bytes, base64. |
sha256 | string | sha256:<hex> of the value. |
version | uint64 | The version, increasing per key. |
expires_at_unix_ms | int64 | Expiry in Unix milliseconds; zero never expires. |
updated_at_unix_ms | int64 | When this version was written, in Unix milliseconds. |
#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-increments" \
-H "Authorization: Bearer $SYLPHX_API_KEY" \
-H "Content-Type: application/json" \
-d '{"key":"…","namespace_id":"…"}'