bus

Search hosts using filters

Changed on Jul 3, 2025

Returns a filtered list of hosts based on specified criteria

post/bus/hosts

Request

The document declares no server URL.
Auth
none declared

Request body

usabilityMode'usable' | 'unusable' | 'all'

filterMode'allowed' | 'blocked' | 'all'

offsetinteger

The number of hosts to skip

limitinteger

The maximum number of hosts to return

addressContainsstring

The host's net address to search for

keyInPublicKey[]

maxLastScanstring date-time

Response

List of filtered hosts

knownSincestring date-time

The time the host was first seen

lastAnnouncementstring date-time

The time the host last announced itself

publicKeystring

A ed25519 public key

netAddressstring

The address of the host

scannedboolean

Whether the host has been scanned

blockedboolean

Whether the host is blocked

storedDatainteger

The amount of data stored on the host in bytes

v2SiamuxAddressesstring[]

Example response

[
  {
    "netAddress": "foo.bar:1234",
    "v2Settings": {
      "protocolVersion": [
        1,
        2,
        3
      ],
      "release": "hostd 1.0.0"
    },
    "v2SiamuxAddresses": [
      "foo.bar:5678"
    ]
  }
]

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 (5 revisions)