Edit tag

PUT /v1/tags/:tag

Token scope required: tags: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 configOverrides.

Unless "before" or "after" are specified, the priority will not change.

Request

Path Parameters

tag string required
Example: env:prod

application/json

Request Body required

description string
Possible values: <= 255 characters
Optional description
configOverrides object[]
List of config overrides for the nebula config
Array [
anyOf
lighthouse.dns.host
lighthouse.dns.port
lighthouse.local_allow_list
lighthouse.remote_allow_list
lighthouse.serve_dns
listen.batch
listen.read_buffer
listen.write_buffer
logging.format
logging.level
logging.timestamp_format
preferred_ranges
routines
stats.host
stats.interval
stats.lighthouse_metrics
stats.listen
stats.message_metrics
stats.namespace
stats.path
stats.prefix
stats.subsystem
stats.type
tun.dev
tun.mtu
tun.tx_queue
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
]

before key:value

If specified, the new tag will be moved before this tag (i.e. will have a lower priority / precedence than the "before" tag.) Cannot be specified in combination with "after."

after key:value

If specified, the new tag will be moved after this tag (i.e. will have a higher priority / precedence than the "after" tag.) Cannot be specified in combination with "before."

routeSubscriptions route-id[]

A list of route IDs to which any hosts with this tag will be subscribed.

Responses

Successful operation

application/json

Schema
Example (from schema)

Schema

data object
name key:value
key is max 20 characters, value is max 50 characters, no whitespace around either allowed
description string
configOverrides object[]
List of config overrides for the nebula config
Array [
anyOf
lighthouse.dns.host
lighthouse.dns.port
lighthouse.local_allow_list
lighthouse.remote_allow_list
lighthouse.serve_dns
listen.batch
listen.read_buffer
listen.write_buffer
logging.format
logging.level
logging.timestamp_format
preferred_ranges
routines
stats.host
stats.interval
stats.lighthouse_metrics
stats.listen
stats.message_metrics
stats.namespace
stats.path
stats.prefix
stats.subsystem
stats.type
tun.dev
tun.mtu
tun.tx_queue
key string required
Possible values: [lighthouse.dns.host]
value string required
]
priority integer
Priority is managed by the API. Use "before" and "after" inputs to order tags. Config overrides associated with tags of a higher (greater) priority take precedence over lower priorities.
hostCount int64
Count of hosts which have the tag assigned.
routeSubscriptions route-id[]
Route IDs to which any hosts with this tag will be subscribed.

metadata object

{
  "data": {
    "name": "env:prod",
    "description": "Hosts which have live in or have access to production resources",
    "configOverrides": [
      {
        "key": "logging.level",
        "value": "info"
      }
    ],
    "priority": 3,
    "hostCount": 10,
    "routeSubscriptions": [
      "route-X47KHSCOSQJP5IOKNNKRRGHVAI"
    ]
  },
  "metadata": {}
}

Validation error

application/json

Schema
Example (from schema)
invalidBeforeOrAfter
beforeAndAfter

Schema

errors object[]
Array [
code string required
A static name for the error type
message string required
A short human readable description of the error
path string nullable
Describes the variable missing or malformed
]

{
  "errors": [
    {
      "code": "string",
      "message": "string",
      "path": "string"
    }
  ]
}

Cannot find the supplied "before" or "after" tag.

{
  "errors": [
    {
      "code": "ERR_INVALID_REFERENCE",
      "message": "referenced value is invalid (perhaps it does not exist?)",
      "path": "before"
    }
  ]
}

Only one of "before" or "after" may be specified.

{
  "errors": [
    {
      "code": "ERR_INVALID_VALUE",
      "message": "may only set before or after, not both",
      "path": "before"
    },
    {
      "code": "ERR_INVALID_VALUE",
      "message": "may only set before or after, not both",
      "path": "after"
    }
  ]
}

Edit tag

Request​

Request