Sign in

v1

latestOpenAPI 3.0.02026-07-17120114186.8 KB
bus

Search hosts using filters

Returns a filtered list of hosts based on specified criteria

post/bus/hosts

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