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

Changes

Changed in 5 of the 50 revisions of this API.12212

    • removed the optional property items/priceTable from the response with the 200 status

      response-optional-property-removed

    • removed the optional property items/settings from the response with the 200 status

      response-optional-property-removed

    This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • c878f2715ffd1010See the full diff
    • the items/v2Settings/prices/collateral response property's maxLength was unset from 39 for the response status 200

      response-property-max-length-unset

    • the items/v2Settings/prices/contractPrice response property's maxLength was unset from 39 for the response status 200

      response-property-max-length-unset

    • the items/v2Settings/prices/egressPrice response property's maxLength was unset from 39 for the response status 200

      response-property-max-length-unset

    • the items/v2Settings/prices/ingressPrice response property's maxLength was unset from 39 for the response status 200

      response-property-max-length-unset

    • the items/v2Settings/prices/storagePrice response property's maxLength was unset from 39 for the response status 200

      response-property-max-length-unset

    • the items/v2Settings/prices/collateral response's property type/format changed from string/ to / for status 200

      response-property-type-changed

    • the items/v2Settings/prices/contractPrice response's property type/format changed from string/ to / for status 200

      response-property-type-changed

    • the items/v2Settings/prices/egressPrice response's property type/format changed from string/ to / for status 200

      response-property-type-changed

    • the items/v2Settings/prices/ingressPrice response's property type/format changed from string/ to / for status 200

      response-property-type-changed

    • the items/v2Settings/prices/storagePrice response's property type/format changed from string/ to / for status 200

      response-property-type-changed

    • added Currency subschema #2 to the items/v2Settings/prices/collateral response property allOf list for the response status 200

      response-property-all-of-added

    • added Currency subschema #2 to the items/v2Settings/prices/contractPrice response property allOf list for the response status 200

      response-property-all-of-added

    • added Currency subschema #2 to the items/v2Settings/prices/egressPrice response property allOf list for the response status 200

      response-property-all-of-added

    • added Currency subschema #2 to the items/v2Settings/prices/ingressPrice response property allOf list for the response status 200

      response-property-all-of-added

    • added Currency subschema #2 to the items/v2Settings/prices/storagePrice response property allOf list for the response status 200

      response-property-all-of-added

    • the items/v2Settings/prices/collateral response's property pattern ^\d+$ was removed for the status 200

      response-property-pattern-removed

    • the items/v2Settings/prices/contractPrice response's property pattern ^\d+$ was removed for the status 200

      response-property-pattern-removed

    • the items/v2Settings/prices/egressPrice response's property pattern ^\d+$ was removed for the status 200

      response-property-pattern-removed

    • the items/v2Settings/prices/ingressPrice response's property pattern ^\d+$ was removed for the status 200

      response-property-pattern-removed

    • the items/v2Settings/prices/storagePrice response's property pattern ^\d+$ was removed for the status 200

      response-property-pattern-removed

  • 922f156353c911See the full diff
    • removed the media type text/plain for the response with the status 500

      response-media-type-removed

    • api tag bus added

      api-tag-added

    • endpoint added

      endpoint-added

    • api path removed without deprecation

      api-path-removed-without-deprecation

    This revision also has 99 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog