Edit host

PUT /v2/hosts/:hostID

Token scope required: hosts:update

caution

Any properties not provided in the request will be reset to their default values. Be sure to include all current values you don't want to change, including tags and configOverrides.

Request

Path Parameters

• hostID string required
  Example: host-24NVITKMNU3CYCEDNFWKAOBX7I

application/json

Request Body required

• name string

  Possible values: non-empty and <= 255 characters

  Name of the host

• roleID string nullable

  ID of the role you want to assign

• staticAddresses address:port[]

  List of static IPv4:port/hostname:port addresses. At least one is required if isLighthouse is true.

• listenPort integer

  Possible values: <= 65535

  The UDP port nebula should use on the host. An available port will be automatically selected if 0 is specified. Required for lighthouses and relays.

• 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
• ]