Skip to main content
POST
kv.entry.expiry.set

Authorizations

Authorization
string
header
required

API key: sk_live_…

Headers

Idempotency-Key
string
required

Required: this capability has an external effect.

Maximum string length: 255
Pramaan-Max-Price-Micro
string

Optional. The most this request may be priced at, in micro-USD (a whole number above 0). It replaces the capability's own price ceiling for this request, lower or higher. Sources that could cost more are left out; when none is left the answer is 400 with the lowest limit that would work.

Pattern: ^[1-9]\d{0,14}$
Pramaan-Account
string

Optional. One of your account ids (GET /v1/accounts): run on that account, whatever your routing rules say. The response header X-Pramaan-Account names the account that ran.

Pramaan-End-User
string

Optional. Your own tag for your end user: a sticky: end_user rule keeps them on the account that first served them.

Maximum string length: 256
Pramaan-End-User-Group
string

Optional. Your end user's group, matched by rules with endUserGroup.

Maximum string length: 64

Body

application/json
namespace
string
required

Your logical namespace, 1 to 128 UTF-8 bytes.

Minimum string length: 1
key
string
required

Your key, used exactly as given in a connected database.

Minimum string length: 1
ttlMs
integer

Milliseconds until expiry; zero deletes immediately and requires confirm true.

Required range: 0 <= x <= 2592000000
expiresAt
string<date-time>

Absolute expiry in UTC; a past time needs confirm true.

Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$
persistent
boolean

Remove the expiry.

confirm
boolean

Required for immediate expiry.

condition
enum<string>
default:always

Expiry condition: always, absent, present, greater or less than the existing expiry.

Available options:
always,
absent,
present,
greater,
less

Response

The result

updated
boolean
required

Whether expiry was changed.