Sign in
latestOpenAPI 3.1.12026-08-198571,0002.4 MB

d8d7501dde48

ApiKeys

Creates a new API key for the tenant. IMPORTANT: The full API key is only returned once during creation. Store it securely - you cannot retrieve it again.

post/api/tenants/{tenantId}/api-keys

Path parameters

tenantIdstring required

The tenant ID.

Request body

namestring required

Human-readable name for the API key.

descriptionstring nullable

Optional description of what this key is used for.

scopesstring[] nullable

Scopes to grant. Defaults to ["read", "write"] if not specified.

expiresAtstring date-time nullable

Optional expiration date.

allowedIpAddressesstring[] nullable

Optional IP allowlist. If set, only requests from these IPs are allowed.

metadataobject nullable

Additional metadata.

Response

Created

apiKeystring required
keyHashstring required
keyPrefixstring required
tenantIdstring required
namestring required
scopesstring[] required
createdAtstring date-time required