latestOpenAPI 3.0.32026-08-137683171.1 KB

be08f4f706f5

ApiKeys

Create API key

Creates a new API key and its actor record. The role must not have broader permissions than the creating user's role (prevents privilege escalation). Response includes the raw key exactly once.

post/api-keys

Headers

Idempotency-Keystring uuid

Idempotency key for POST requests. If a transaction with the same key already exists for the org, the server returns the original response without re-executing. Keys are valid for 48 hours.

Request body

namestring required

roleIdstring uuid required

expiresAtnumber

Unix timestamp in milliseconds for key expiration

Response

Created — the raw key is included and cannot be retrieved again

transactionIdstring uuid required