Create tag
POST/v1/tags
Create a new tag, optionally with config overrides.
Token scope required: tags:create
Request
- application/json
Body
required
Array [
- 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
- MOD1
]
Name of the new tag. Key must not be longer than 20 characters. Value must not be longer than 50 characters. No whitespace around either allowed.
Possible values: <= 255 characters
Optional description
configOverrides
object[]
List of config overrides for the nebula config
anyOf
Possible values: [lighthouse.dns.host]
Possible values: [lighthouse.dns.port]
Possible values: [lighthouse.local_allow_list]
value
object
required
interfaces
object
required
property name*
object
anyOf
boolean
Possible values: [lighthouse.remote_allow_list]
value
object
required
Possible values: [lighthouse.serve_dns]
Possible values: [listen.batch]
Possible values: [listen.read_buffer]
Possible values: [listen.write_buffer]
Possible values: [logging.format]
Possible values: [text, json]
Possible values: [logging.level]
Possible values: [panic, fatal, error, warning, info, debug]
Possible values: [logging.timestamp_format]
Possible values: [preferred_ranges]
Possible values: [routines]
Possible values: [stats.host]
Possible values: [stats.interval]
Possible values: [stats.lighthouse_metrics]
Possible values: [stats.listen]
Possible values: [stats.message_metrics]
Possible values: [stats.namespace]
Possible values: [stats.path]
Possible values: [stats.prefix]
Possible values: [stats.subsystem]
Possible values: [stats.type]
Possible values: [graphite, prometheus]
Possible values: [tun.dev]
Possible values: [tun.mtu]
Possible values: [tun.tx_queue]
If specified, the new tag will be inserted before this tag (i.e. will have a lower priority / precedence than the "before" tag.) Cannot specify this in combination with "after."
If specified, the new tag will be inserted after this tag (i.e. will have a higher priority / precedence than the "after" tag.) Cannot specify this in combination with "before."
A list of route IDs to which any hosts with this tag will be subscribed.
Responses
- 200
- 400
Successful operation
- application/json
- Schema
- Example (from schema)
- Example
Schema
Array [
- 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
- MOD1
]
data
object
key is max 20 characters, value is max 50 characters, no whitespace around either allowed
configOverrides
object[]
List of config overrides for the nebula config
anyOf
Possible values: [lighthouse.dns.host]
Possible values: [lighthouse.dns.port]
Possible values: [lighthouse.local_allow_list]
value
object
required
interfaces
object
required
property name*
object
anyOf
boolean
Possible values: [lighthouse.remote_allow_list]
value
object
required
Possible values: [lighthouse.serve_dns]
Possible values: [listen.batch]
Possible values: [listen.read_buffer]
Possible values: [listen.write_buffer]
Possible values: [logging.format]
Possible values: [text, json]
Possible values: [logging.level]
Possible values: [panic, fatal, error, warning, info, debug]
Possible values: [logging.timestamp_format]
Possible values: [preferred_ranges]
Possible values: [routines]
Possible values: [stats.host]
Possible values: [stats.interval]
Possible values: [stats.lighthouse_metrics]
Possible values: [stats.listen]
Possible values: [stats.message_metrics]
Possible values: [stats.namespace]
Possible values: [stats.path]
Possible values: [stats.prefix]
Possible values: [stats.subsystem]
Possible values: [stats.type]
Possible values: [graphite, prometheus]
Possible values: [tun.dev]
Possible values: [tun.mtu]
Possible values: [tun.tx_queue]
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.
Count of hosts which have the tag assigned.
Route IDs to which any hosts with this tag will be subscribed.
{
"data": {
"name": "key:value",
"description": "string",
"configOverrides": [
{},
{},
{},
{},
{},
{},
{},
{},
{},
{},
{},
{},
{},
{},
{},
{},
{},
{},
{},
{},
{},
{},
{},
{},
{},
{}
],
"priority": 0,
"hostCount": 0,
"routeSubscriptions": [
"route-X47KHSCOSQJP5IOKNNKRRGHVAI"
]
},
"metadata": {}
}
{
"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
},
"metadata": {}
}
Validation error
- application/json
- Schema
- Example (from schema)
- existingTagName
- invalidBeforeOrAfter
- beforeAndAfter
Schema
Array [
]
errors
object[]
A static name for the error type
A short human readable description of the error
Describes the variable missing or malformed
{
"errors": [
{
"code": "string",
"message": "string",
"path": "string"
}
]
}
{
"errors": [
{
"code": "ERR_DUPLICATE_VALUE",
"message": "value already exists",
"path": "name"
}
]
}
{
"errors": [
{
"code": "ERR_INVALID_REFERENCE",
"message": "referenced value is invalid (perhaps it does not exist?)",
"path": "before"
}
]
}
{
"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"
}
]
}