bus

Scan host

Changed on Jul 3, 2025

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

post/bus/host/{hostkey}/scan

Request

The document declares no server URL.
Auth
none declared

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"
  }
}

Changes

Jul 3, 2025472331be123c Revision changes
- warning
  removed the optional property from the response with the status
- warning
  removed the optional property from the response with the status
Mar 13, 2025c878f2715ffd Revision changes
- breaking
  the // response property's maxLength was unset from 39 for the response status
- breaking
  the // response property's maxLength was unset from 39 for the response status
- breaking
  the // response property's maxLength was unset from 39 for the response status
- breaking
  the // response property's maxLength was unset from 39 for the response status
- breaking
  the // response property's maxLength was unset from 39 for the response status
- breaking
  the // response's property type changed from string to no type for status
- breaking
  the // response's property type changed from string to no type for status
- breaking
  the // response's property type changed from string to no type for status
- breaking
  the // response's property type changed from string to no type for status
- breaking
  the // response's property type changed from string to no type for status
- info
  added subschema #2 to the // response property allOf list for the response status
- info
  added subschema #2 to the // response property allOf list for the response status
- info
  added subschema #2 to the // response property allOf list for the response status
- info
  added subschema #2 to the // response property allOf list for the response status
- info
  added subschema #2 to the // response property allOf list for the response status
- info
  the // response's property pattern ^\d+$ was removed for the status
- info
  the // response's property pattern ^\d+$ was removed for the status
- info
  the // response's property pattern ^\d+$ was removed for the status
- info
  the // response's property pattern ^\d+$ was removed for the status
- info
  the // response's property pattern ^\d+$ was removed for the status

Operation history (6 revisions)