Skip to main content
POST
Rotate an ingest key with an overlap

Authorizations

hookie_session
string
cookie
required

The console's sealed session cookie, set by WorkOS AuthKit. Mutating requests also require the X-Requested-With CSRF header.

Path Parameters

pid
string
required

Project id (UUID) belonging to the caller workspace.

id
string
required

Ingest key id (the key being replaced).

Body

application/json
overlap_hours
number
default:24

How long the OLD credential keeps working, in hours (at most 30 days). 0 ends it at once.

Required range: 0 <= x <= 720
expires_at
string<date-time> | null

Optional expiry for the NEW key. Default: none.

Response

The new key. key and signing_secret are shown exactly once.

id
string
required
key
string
required

ik_live_ followed by 48 hex characters.

key_prefix
string
required
signing_secret
string | null
required

A new whsec_ secret when the key requires signatures; otherwise null.

expires_at
string<date-time> | null
required
previous_key
object
required