ScanopyScanopy
Daemons

Generate daemon install command

A pure, idempotent builder — it never mints or persists anything. The api key in an install command is a placeholder (<API_KEY>) the caller substitutes from the plaintext it holds; a reconfigure command carries no key at all. Minting is a separate mutation (POST /provision), so regenerating a command here (advanced-setting change, OS switch, the Details reconfigure view) never rotates the daemon's key.

The server derives the exact command shape from the record: DaemonPoll vs ServerPoll for the flags, and — for install — whether the daemon has checked in (last_seen) to decide between a first-install and a minimal re-key command.

GET
/api/v1/daemons/{id}/install-command
Authorization<token>

User API key (Bearer scp_u_...). Create in Platform > API Keys.

In: header

Path Parameters

id*string

daemon ID

Formatuuid

Query Parameters

purpose*string

install (with the api-key placeholder) or reconfigure (credential-free).

Value in"install" | "reconfigure"
log_level?string|null
log_file?string|null
heartbeat_interval?integer|null
Formatint64
Range0 <= value
bind_address?string|null
allow_self_signed_certs?boolean|null
accept_invalid_scan_certs?boolean|null
interfaces?string|null

Comma-separated interface names.

credential_refs?string|null

Comma-separated credential/integration tokens (for the docker-compose env).

Response Body

application/json

application/json

curl -X GET "https://loading/api/v1/daemons/497f6eca-6276-4993-bfeb-53cbbbba6f08/install-command?purpose=install"
{
  "meta": {
    "api_version": 1,
    "server_version": "0.17.5"
  },
  "success": true,
  "data": {
    "docker": {
      "env": [
        "string"
      ],
      "compose": "string"
    },
    "freebsd": "string",
    "linux": "string",
    "macos": "string",
    "msi": {
      "filename": "string",
      "omitted_config_keys": [
        "string"
      ]
    },
    "windows": "string"
  },
  "error": "string"
}
{
  "meta": {
    "api_version": 1,
    "server_version": "0.17.5"
  },
  "success": true,
  "code": "string",
  "error": "string",
  "params": {
    "property1": null,
    "property2": null
  }
}