Get host

GET /v1/hosts/:hostID

Fetch information about a particular host, lighthouse, or relay.

Token scope required: hosts:read

Request

Path Parameters

• hostID string required
  Example: host-24NVITKMNU3CYCEDNFWKAOBX7I

Responses

• 200

---

Successful operation

application/json

Schema

Schema

• data object

  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

  lighthouse.dns.host

  key string required

  Possible values: [lighthouse.dns.host]

  value string required

  key string required

  Possible values: [lighthouse.dns.port]

  value number required

  key string required

  Possible values: [lighthouse.local_allow_list]

  value object required

  interfaces object required

  property name* boolean

  anyOf

  key string required

  Possible values: [lighthouse.remote_allow_list]

  value object required

  property name* boolean

  key string required

  Possible values: [lighthouse.serve_dns]

  value boolean required

  key string required

  Possible values: [listen.batch]

  value number required

  key string required

  Possible values: [listen.read_buffer]

  value number required

  key string required

  Possible values: [listen.write_buffer]

  value number required

  key string required

  Possible values: [logging.format]

  value string required

  Possible values: [text, json]

  key string required

  Possible values: [logging.level]

  value string required

  Possible values: [panic, fatal, error, warning, info, debug]

  key string required

  Possible values: [logging.timestamp_format]

  value string required

  key string required

  Possible values: [preferred_ranges]

  value string[] required

  key string required

  Possible values: [routines]

  value number required

  key string required

  Possible values: [stats.host]

  value string required

  key string required

  Possible values: [stats.interval]

  value string required

  key string required

  Possible values: [stats.lighthouse_metrics]

  value boolean required

  key string required

  Possible values: [stats.listen]

  value string required

  key string required

  Possible values: [stats.message_metrics]

  value boolean required

  key string required

  Possible values: [stats.namespace]

  value string required

  key string required

  Possible values: [stats.path]

  value string required

  key string required

  Possible values: [stats.prefix]

  value string required

  key string required

  Possible values: [stats.subsystem]

  value string required

  key string required

  Possible values: [stats.type]

  value string required

  Possible values: [graphite, prometheus]

  key string required

  Possible values: [tun.dev]

  value string required

  key string required

  Possible values: [tun.mtu]

  value number required

  key string required

  Possible values: [tun.tx_queue]

  value number required

  ]

metadata object

{
  "data": {
    "id": "string",
    "organizationID": "string",
    "networkID": "string",
    "roleID": "string",
    "name": "string",
    "ipAddress": "198.51.100.42",
    "staticAddresses": [
      "string"
    ],
    "listenPort": 0,
    "isLighthouse": false,
    "isRelay": false,
    "createdAt": "2024-03-29T16:40:56.580Z",
    "isBlocked": false,
    "metadata": {
      "lastSeenAt": "string",
      "version": "string",
      "platform": "dnclient",
      "updateAvailable": true
    },
    "tags": [
      "string"
    ],
    "configOverrides": [
      {
        "key": "lighthouse.dns.host",
        "value": "string"
      },
      {
        "key": "lighthouse.dns.port",
        "value": 0
      },
      {
        "key": "lighthouse.local_allow_list",
        "value": {
          "interfaces": {}
        }
      },
      {
        "key": "lighthouse.remote_allow_list",
        "value": {}
      },
      {
        "key": "lighthouse.serve_dns",
        "value": true
      },
      {
        "key": "listen.batch",
        "value": 0
      },
      {
        "key": "listen.read_buffer",
        "value": 0
      },
      {
        "key": "listen.write_buffer",
        "value": 0
      },
      {
        "key": "logging.format",
        "value": "text"
      },
      {
        "key": "logging.level",
        "value": "panic"
      },
      {
        "key": "logging.timestamp_format",
        "value": "string"
      },
      {
        "key": "preferred_ranges",
        "value": [
          "string"
        ]
      },
      {
        "key": "routines",
        "value": 0
      },
      {
        "key": "stats.host",
        "value": "string"
      },
      {
        "key": "stats.interval",
        "value": "string"
      },
      {
        "key": "stats.lighthouse_metrics",
        "value": true
      },
      {
        "key": "stats.listen",
        "value": "string"
      },
      {
        "key": "stats.message_metrics",
        "value": true
      },
      {
        "key": "stats.namespace",
        "value": "string"
      },
      {
        "key": "stats.path",
        "value": "string"
      },
      {
        "key": "stats.prefix",
        "value": "string"
      },
      {
        "key": "stats.subsystem",
        "value": "string"
      },
      {
        "key": "stats.type",
        "value": "graphite"
      },
      {
        "key": "tun.dev",
        "value": "string"
      },
      {
        "key": "tun.mtu",
        "value": 0
      },
      {
        "key": "tun.tx_queue",
        "value": 0
      }
    ]
  },
  "metadata": {}
}

{
  "data": {
    "createdAt": "2023-01-25T18:15:27Z",
    "id": "host-24NVITKMNU3CYCEDNFWKAOBX7I",
    "ipAddress": "100.100.0.29",
    "isBlocked": false,
    "isLighthouse": false,
    "isRelay": false,
    "listenPort": 0,
    "name": "Host 1",
    "networkID": "network-KAOWMXZHZWCVMGGFKM22XEGYLE",
    "organizationID": "org-F63A24JGCLJV3ZEUTLCBISGETA",
    "roleID": "role-PZEDBXHCEXKAKJPZ6XOQTIAJA4",
    "staticAddresses": [],
    "metadata": {
      "lastSeenAt": "2023-04-05T17:19:42Z",
      "platform": "dnclient",
      "updateAvailable": false,
      "version": "0.1.9"
    }
  },
  "metadata": {}
}

If the host has not been enrolled, its metadata will be unknown (null values).

{
  "data": {
    "createdAt": "2023-01-25T18:15:27Z",
    "id": "host-24NVITKMNU3CYCEDNFWKAOBX7I",
    "ipAddress": "100.100.0.29",
    "isBlocked": false,
    "isLighthouse": false,
    "isRelay": false,
    "listenPort": 0,
    "name": "Host 1",
    "networkID": "network-KAOWMXZHZWCVMGGFKM22XEGYLE",
    "organizationID": "org-F63A24JGCLJV3ZEUTLCBISGETA",
    "roleID": "role-PZEDBXHCEXKAKJPZ6XOQTIAJA4",
    "staticAddresses": [],
    "metadata": {
      "lastSeenAt": null,
      "platform": null,
      "updateAvailable": null,
      "version": null
    }
  },
  "metadata": {}
}