Skip to main content
POST
Rotate a workspace API key with bounded overlap; preserve permissions and expiry unless explicitly changed. Administrators only.

Authorizations

Authorization
string
header
required

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

Headers

Idempotency-Key
string
required

Bound to actor, operation, target, schema version and canonical payload; changed input returns 409.

Required string length: 8 - 255

Path Parameters

orgId
string
required
Pattern: ^[0-7][0-9A-HJKMNP-TV-Z]{25}$
id
string
required
Pattern: ^[0-7][0-9A-HJKMNP-TV-Z]{25}$

Body

application/json
overlapSeconds
integer
Required range: 0 <= x <= 86400
name
string
Required string length: 1 - 255
access
enum<string>
Available options:
read,
edit
includeAdmin
boolean
expiresAt
string<date-time> | null

UTC instant with mandatory Z and at most three fractional digits.

Pattern: ^(?!0000)\d{4}-\d{2}-\d{2}T(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d{1,3})?Z$
Example:

"2024-01-01T12:30:00.000Z"

Response

Authorised operation result.

key
object
required
secret
string
replayed
boolean