ApiKey

idstring<uuid>

labelstring

displaystring

How to recognise the key: its prefix and the last 4 characters (older keys: nk_1a2b3c4d...wXyZ, or ...wXyZ only for keys from before 11 October 2026)

Example: nuntiq_ck_live_1a2b3c4d...wXyZ

prefixstring

legacy for keys from before October 2026

last_4string

legacyboolean

statusstring

grace: replaced, still works until grace_until; rotated: replaced and the grace period is over

Possible values: [active, grace, rotated, expired, revoked]

created_atstring<date-time>

created_bystringnullable

created_viastring

Possible values: [portal, admin, api, migration]

expires_atstring<date-time>

last_used_atstring<date-time>nullable

Updated at most once a minute

grace_untilstring<date-time>nullable

revoked_atstring<date-time>nullable

revoked_bystringnullable

replaced_by_key_idstring<uuid>nullable

ApiKey

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "label": "string",
  "display": "nuntiq_ck_live_1a2b3c4d...wXyZ",
  "prefix": "string",
  "last_4": "string",
  "legacy": true,
  "status": "active",
  "created_at": "2024-07-29T15:51:28.071Z",
  "created_by": "string",
  "created_via": "portal",
  "expires_at": "2024-07-29T15:51:28.071Z",
  "last_used_at": "2024-07-29T15:51:28.071Z",
  "grace_until": "2024-07-29T15:51:28.071Z",
  "revoked_at": "2024-07-29T15:51:28.071Z",
  "revoked_by": "string",
  "replaced_by_key_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}