ApiKeyCreateResponse

The response to creating a key: the full ApiKeyDto plus the plaintext token, which is shown only here. Subsequent reads (get/list) never return the token, so the client must store it now; it cannot be recovered later.

key object

The created key

idstring

The key id

Example: 7Hb2Kp9QvL3mNx0R8tZ4

namestring

Human-readable label for the key

Example: billing-sync

prefixstring

Token prefix (e.g. adb_live)

Example: adb_live

display_last4string

Last 4 characters of the token, for identification in a UI

Example: a1b2

super_userboolean

True if the key has cross-network (super-user) access; then scopes is empty

Example: false

statusstring

Key status

Possible values: [active, revoked, expired]

Example: active

scopes object[]

Per-network access the key holds

Array [

network_idstring

The network this scope grants access to

Example: 7Hb2Kp9QvL3mNx0R8tZ4

rolestring

Role held on this network

Possible values: [read_only, administrator]

Example: read_only

network_urlstring

Link to this network, so the key can navigate without constructing ids

Example: https://api.adbridge.ai/external/v1/networks/7Hb2Kp9QvL3mNx0R8tZ4

]

created_atdate-time

When the key was created

Example: 2026-01-15T09:30:00Z

last_used_atdate-timenullable

When the key was last used to authenticate a request, if ever

Example: 2026-01-15T09:30:00Z

expires_atdate-timenullable

When the key expires, if an expiry was set; null means it never expires

Example: 2026-01-15T09:30:00Z

tokenstring

The plaintext API token. Shown ONLY on create — store it now; it cannot be retrieved again. Send it as Authorization: Bearer <token>.

Example: adb_live_xxxxxxxxxxxxxxxxxxxxxxxxxxxx

ApiKeyCreateResponse

{
  "key": {
    "id": "7Hb2Kp9QvL3mNx0R8tZ4",
    "name": "billing-sync",
    "prefix": "adb_live",
    "display_last4": "a1b2",
    "super_user": false,
    "status": "active",
    "scopes": [
      {
        "network_id": "7Hb2Kp9QvL3mNx0R8tZ4",
        "role": "read_only",
        "network_url": "https://api.adbridge.ai/external/v1/networks/7Hb2Kp9QvL3mNx0R8tZ4"
      }
    ],
    "created_at": "2026-01-15T09:30:00Z",
    "last_used_at": "2026-01-15T09:30:00Z",
    "expires_at": "2026-01-15T09:30:00Z"
  },
  "token": "adb_live_xxxxxxxxxxxxxxxxxxxxxxxxxxxx"
}