Get tag

GET /v1/tags/:tag

Fetch information about a particular tag.

Token scope required: tags:read

Request

Path Parameters

• tag string required
  Example: env:prod

Responses

• 200

---

Successful operation

application/json

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

  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

  ]
• 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": "key:value",
    "description": "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
      }
    ],
    "priority": 0,
    "hostCount": 0,
    "routeSubscriptions": [
      "route-X47KHSCOSQJP5IOKNNKRRGHVAI"
    ]
  },
  "metadata": {}
}

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