Sign in
Daemon API Keys

Create Daemon API Key

post/api/v1/auth/daemon

Request body

daemon_idstring uuid nullable

Daemon this key is bound to 1:1, when provisioned server-side. NULL for legacy network-shared keys created before 1:1 provisioning, which resolve daemon identity from the X-Daemon-ID header instead.

expires_atstring date-time nullable

When this record stops being valid.

is_enabledboolean

Whether the key may still be used. Disabled keys are rejected.

keystring required

The stored key. Returned redacted except on creation and rotation.

last_usedstring date-time nullable required

When a daemon last authenticated with this key.

namestring required

Human-facing name for this key.

network_idstring uuid required

The network this entity belongs to.

tagsstring[] required

Tags assigned to this entity.

created_atstring date-time required

When this record was first created.

idstring uuid required

Server-assigned unique identifier.

updated_atstring date-time required

When this record was last modified.

Response

Daemon API key created

errorstring nullable

Human-readable failure message. Omitted on success.

successboolean required

true when the request succeeded. false responses carry error instead of data.

Example response

{
  "meta": {
    "api_version": 1,
    "server_version": "0.17.13"
  }
}

Changes