Skip to main content

List hosts

GET /v1/hosts

Get a paginated list of hosts, lighthouses, and relays.

Token scope required: hosts:list

Request

Query Parameters
  • includeCounts boolean

    If true, return count of total records and current page start and count in metadata

  • cursor string

    Cursor value at which to start the results, provided in nextCursor or prevCursor of a prior request

    Example: bmV4dA.eyJsb2dzLmNyZQ5iIiwiX3ZhbHVlIjo9In19
  • pageSize integer

    Possible values: <= 500

    Default value: 25

    Number of records to return in each page

  • filter.isBlocked boolean

    Return only hosts that are blocked if true, unblocked if false

  • filter.isLighthouse boolean

    Return only lighthouses if true, non-lighthouses if false

  • filter.isRelay boolean

    Return only relays if true, non-relays if false

  • filter.metadata.lastSeenAt string

    Possible values: [null]

    When "null", returns hosts that have never communicated with the Defined Networking service.

  • filter.metadata.platform string

    Possible values: [mobile, dnclient, null]

    Return only hosts matching the specified client platform

  • filter.metadata.updateAvailable boolean

    Return only hosts that have updates available when true, or up-to-date hosts when false

Responses

Successful operation

Schema
  • data object[]
  • Array [
  • id string
  • organizationID string
  • networkID string
  • roleID string nullable
  • name string
  • ipAddress ipv4
  • staticAddresses address:port[]
  • listenPort int64

    Will be zero if a regular host

  • isLighthouse boolean

    Default value: false

  • isRelay boolean

    Default value: false

  • createdAt date-time
  • isBlocked boolean

    Default value: false

  • metadata object
  • lastSeenAt string nullable
  • version string nullable
  • platform string nullable

    Possible values: [dnclient, mobile, null]

  • updateAvailable boolean nullable
  • tags key:value[]
  • configOverrides object[]

    List of config overrides for the nebula config

  • Array [
  • anyOf
  • key string required

    Possible values: [lighthouse.dns.host]

  • value string required
  • ]
  • ]
  • metadata object
  • totalCount integer

    The total number of resources existing in the account

  • hasNextPage boolean

    Is there a page of data that can be fetched using the nextCursor?

  • hasPrevPage boolean

    Is there a page of data that can be fetched using the prevCursor?

  • nextCursor string

    An opaque string that can be used to fetch the next page of results. Not provided if result set is empty.

  • prevCursor string

    An opaque string that can be used to fetch the next page of results. Not provided if result set is empty.

  • page object
  • count integer required

    The number of results returned in the response.

  • start integer required

    The zero-based index of the first result within the overall list. For example, the first page will have a start of 0. If 25 results are fetched, and the nextCursor used to fetch a new page of results, the second request's start will be 25.

  • Loading...