Sign in

v1

latestOpenAPI 3.0.02026-07-17120114186.8 KB
bus

Scan host

Performs a scan of the host to check its settings and availability

post/bus/host/{hostkey}/scan

Path parameters

hostkeystring required

A ed25519 public key

Public key of the host

Request body

timeoutinteger

Scan timeout in milliseconds

Example request

{
  "timeout": 30000
}

Response

Host scan results

pinginteger

Round trip time in milliseconds

scanErrorstring

Example response

{
  "ping": 30000,
  "v2Settings": {
    "protocolVersion": [
      1,
      2,
      3
    ],
    "release": "hostd 1.0.0"
  }
}