Skip to main content
PUT
Write a KV entry

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

if-match
string

Apply only if the entry's current version equals this value (its ETag).

Pattern: ^(?:W\/)?"?\d+"?$
if-none-match
enum<string>

Send * to write only if the key does not exist.

Available options:
*

Path Parameters

key
string
required

Key, 1-512 characters from A-Z a-z 0-9 . _ : -. Use : to namespace keys, e.g. pw-lock:1234:user-settings.

Pattern: ^[A-Za-z0-9._:-]{1,512}$

Body

application/json
value
required

JSON value to store (max 1 MB serialized).

ttl
integer
required

Time-to-live in seconds (max 30 days).

Required range: 1 <= x <= 2592000

Response

The entry was replaced.

data
object
required

Response payload.