SCscanopy
Daemons
internal

Test reachability of a daemon URL

Changed on

Performs a TCP connection test and optionally an HTTP health check to verify that a daemon URL is reachable from the server.

post/api/v1/daemons/test-reachability

Request

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

Request body

check_healthboolean

If true, also perform an HTTP GET to {url}/health after the TCP check

urlstring required

Full URL of the daemon (e.g. "https://daemon.example.com:60073")

Response

Reachability test result

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