SCscanopy
Daemons
internal

Daemon startup handshake

Changed on

Internal endpoint for daemons to report their version on startup. Updates the daemon's version and last_seen timestamp, returns server capabilities.

post/api/daemons/{id}/startup

Request

  • Base URL
    https://app.scanopy.net
  • URL
    https://app.scanopy.net/api/daemons/{id}/startup
  • Auth
    API key in header Authorization

Path parameters

idstring uuid required

Daemon ID

Request body

daemon_versionstring required

Daemon software version (semver format)

os'linux' | 'macos' | 'windows' | 'freebsd'

Operating system a daemon is installed on, as picked when it is created.

Response

Startup acknowledged

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

  • 5d5c3b1369a9Revision changes
    • breaking

      the response property / became nullable for the status

    • breaking

      the response property / became optional for the status

    • info

      added the optional property / to the response with the status

  • c0fa21e70349Revision changes
    • info

      added the new optional request property