SCscanopy
Daemons
internal

Receive daemon heartbeat (deprecated)

Changed on

Internal endpoint for legacy daemons to send periodic heartbeats. New daemons (v0.14.0+) use the /request-work endpoint which includes heartbeat functionality. This endpoint is kept for backwards compatibility and will be removed in a future version.

post/api/daemons/{id}/heartbeat

Request

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

Path parameters

idstring uuid required

Daemon ID

Request body

mode'server_poll' | 'daemon_poll' required

Daemon operating mode that determines the communication pattern.

  • DaemonPoll (formerly "Pull"): Daemon makes outbound connections to the server. The daemon registers itself and polls for work. Best for daemons behind NAT/firewall.

  • ServerPoll (formerly "Push"): Server makes connections to the daemon. Server polls daemon for status and discovery results. Best for DMZ deployments where daemon cannot make outbound connections.

namestring required

Name the daemon reports for itself.

urlstring required

URL the daemon is reachable at, as it sees itself.

Response

Heartbeat received

dataTupleUnit

No payload. Present only so the envelope keeps its shape.

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