Skip to main content
POST
Rotate an API key with a zero-downtime overlap window

Authorizations

X-API-Key
string
header
required

Issue from /v1/keys (or admin-issued for enterprise tier).

Headers

authorization
string | null
X-API-Key
string | null
POLY_API_KEY
string | null
Poly-API-Key
string | null

Path Parameters

key_id
integer
required

Response

Successful Response

Returned once on creation — the raw key is NOT stored.

id
integer
required
raw_key
string
required
key_prefix
string
required
rate_limit_tier
string
required
permissions
string[]
required
created_at
string
required
name
string | null
default_magic
integer | null

Magic number (0..9223372036854775807) stamped on every order placed with this key that does not send its own magic. Give each bot its own key to tag its orders without code changes.

default_magic_label
string | null

Bot label (max 32 printable characters) stamped on every order placed with this key that does not send its own magic_label.