latestOpenAPI 3.1.0Proprietary2026-08-1095216168.4 KB

db81a447bba9

API Keys

Create API key

Creates a tenant-scoped API key. Provide role_id to reuse an existing role, or permissions to mint a dedicated single-purpose role automatically. The returned token is shown ONCE - store it immediately, it cannot be retrieved again.

post/tenants/{tenant_id}/api_keys

Path parameters

tenant_idinteger required

Example:7261845022003200000

Tenant identifier

Request body

allowed_ipsstring[] nullable

division_idinteger

expiry_atstring date-time required

Expiration timestamp (RFC 3339 UTC).

namestring required

role_idinteger

validate_ipboolean required

Example request

{
  "division_id": 7261844974723780000,
  "expiry_at": "2026-05-20T10:00:00Z",
  "name": "ci-deployer",
  "role_id": 7261845001236500000
}

Response

API key created. token returned once and never again

idinteger required

tokenstring required

Example response

{
  "id": 7261845127892140000,
  "token": "ld_pk_AbCdEf0123456789AbCdEf0123456789"
}