SCscanopy
Daemon API Keys

Create daemon API key

Changed on
post/api/v1/daemon-api-keys

Request

  • Base URL
    https://app.scanopy.net
  • URL
    https://app.scanopy.net/api/v1/daemon-api-keys
  • Auth
    • API key in header Authorization
    • or API key in cookie session_id

Request body

daemon_idstring uuid nullable

Daemon this key is bound to 1:1, when provisioned server-side. NULL for legacy site-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.

site_idstring uuid required

The site 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

Not sent on a successful response. Failure messages arrive in an ApiErrorResponse.

successboolean required

Always true on a successful response.

Example response

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

Changes