List tags
GET /v2/tags
Get a paginated list of tags.
Token scope required: tags:list
Request
Query Parameters
- includeCounts boolean
If true, return count of total records and current page start and count in metadata
- cursor string
Cursor value at which to start the results, provided in
nextCursor
orprevCursor
of a prior requestExample: bmV4dA.eyJsb2dzLmNyZQ5iIiwiX3ZhbHVlIjo9In19 - pageSize integer
Possible values:
<= 500
Default value:
25
Number of records to return in each page
- 200
Successful operation
- application/json
- Schema
- Example (from schema)
- noParams
- includeCounts
Schema
data object[]
Array [name key:valuekey is max 20 characters, value is max 50 characters, no whitespace around either allowed
description stringconfigOverrides 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 requiredPossible values: [
lighthouse.dns.host
]value string requiredkey string requiredPossible values: [
lighthouse.dns.port
]value number requiredkey string requiredPossible values: [
lighthouse.local_allow_list
]value object required
interfaces object required
property name*
booleananyOfkey string requiredPossible values: [
lighthouse.remote_allow_list
]value object required
property name*
booleankey string requiredPossible values: [
lighthouse.serve_dns
]value boolean requiredkey string requiredPossible values: [
listen.batch
]value number requiredkey string requiredPossible values: [
listen.read_buffer
]value number requiredkey string requiredPossible values: [
listen.write_buffer
]value number requiredkey string requiredPossible values: [
logging.format
]value string requiredPossible values: [
text
,json
]key string requiredPossible values: [
logging.level
]value string requiredPossible values: [
panic
,fatal
,error
,warning
,info
,debug
]key string requiredPossible values: [
logging.timestamp_format
]value string requiredkey string requiredPossible values: [
preferred_ranges
]value string[] requiredkey string requiredPossible values: [
routines
]value number requiredkey string requiredPossible values: [
stats.host
]value string requiredkey string requiredPossible values: [
stats.interval
]value string requiredkey string requiredPossible values: [
stats.lighthouse_metrics
]value boolean requiredkey string requiredPossible values: [
stats.listen
]value string requiredkey string requiredPossible values: [
stats.message_metrics
]value boolean requiredkey string requiredPossible values: [
stats.namespace
]value string requiredkey string requiredPossible values: [
stats.path
]value string requiredkey string requiredPossible values: [
stats.prefix
]value string requiredkey string requiredPossible values: [
stats.subsystem
]value string requiredkey string requiredPossible values: [
stats.type
]value string requiredPossible values: [
graphite
,prometheus
]key string requiredPossible values: [
tun.dev
]value string requiredkey string requiredPossible values: [
tun.mtu
]value number requiredkey string requiredPossible values: [
tun.tx_queue
]value number required]priority integerPriority 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 int64Count of hosts which have the tag assigned.
routeSubscriptions route-id[]Route IDs to which any hosts with this tag will be subscribed.
]metadata object
totalCount integerThe total number of resources existing in the account
hasNextPage booleanIs there a page of data that can be fetched using the
nextCursor
?hasPrevPage booleanIs there a page of data that can be fetched using the
prevCursor
?nextCursor stringAn opaque string that can be used to fetch the next page of results. Not provided if result set is empty.
prevCursor stringAn opaque string that can be used to fetch the next page of results. Not provided if result set is empty.
page object
count integer requiredThe number of results returned in the response.
start integer requiredThe zero-based index of the first result within the overall list. For example, the first page will have a
start
of0
. If 25 results are fetched, and thenextCursor
used to fetch a new page of results, the second request'sstart
will be25
.
{
"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": {
"totalCount": 0,
"hasNextPage": true,
"hasPrevPage": true,
"nextCursor": "string",
"prevCursor": "string",
"page": {
"count": 0,
"start": 0
}
}
}
When includeCounts
parameter is not set to true
{
"data": [
{
"name": "env:prod",
"description": "Production hosts",
"configOverrides": [
{
"key": "logging.level",
"value": "info"
}
],
"priority": 6,
"hostCount": 10,
"routeSubscriptions": [
"route-X47KHSCOSQJP5IOKNNKRRGHVAI"
]
},
{
"name": "env:dev",
"description": "Development hosts",
"configOverrides": [
{
"key": "logging.level",
"value": "debug"
}
],
"priority": 7,
"hostCount": 2,
"routeSubscriptions": []
},
{
"name": "region:us-east-1",
"description": "",
"configOverrides": [],
"priority": 8,
"hostCount": 7,
"routeSubscriptions": []
},
{
"name": "region:us-west-2",
"description": "",
"configOverrides": [],
"priority": 9,
"hostCount": 3,
"routeSubscriptions": []
},
{
"name": "region:eu-central-1",
"description": "",
"configOverrides": [],
"priority": 10,
"hostCount": 2,
"routeSubscriptions": []
}
],
"metadata": {
"hasNextPage": true,
"hasPrevPage": true,
"nextCursor": "bmV4dA.bHVlIjoieGJVS0UvYkRjQmZsY1pUbGJCc",
"prevCursor": "cHJldg.SI6ImIiLCJfdmFsdWUiOiI0dDVuREQreU"
}
}
Metadata returned when including request params for includeCounts=true
, pageSize=5
, and cursor="somevalue"
.
{
"data": [
{
"name": "env:prod",
"description": "Production hosts",
"configOverrides": [
{
"key": "logging.level",
"value": "info"
}
],
"priority": 6,
"hostCount": 10,
"routeSubscriptions": [
"route-X47KHSCOSQJP5IOKNNKRRGHVAI"
]
},
{
"name": "env:dev",
"description": "Development hosts",
"configOverrides": [
{
"key": "logging.level",
"value": "debug"
}
],
"priority": 7,
"hostCount": 2,
"routeSubscriptions": []
},
{
"name": "region:us-east-1",
"description": "",
"configOverrides": [],
"priority": 8,
"hostCount": 7,
"routeSubscriptions": []
},
{
"name": "region:us-west-2",
"description": "",
"configOverrides": [],
"priority": 9,
"hostCount": 3,
"routeSubscriptions": []
},
{
"name": "region:eu-central-1",
"description": "",
"configOverrides": [],
"priority": 10,
"hostCount": 2,
"routeSubscriptions": []
}
],
"metadata": {
"totalCount": 150,
"hasNextPage": true,
"hasPrevPage": true,
"prevCursor": "cHJldg.SI6ImIiLCJfdmFsdWUiOiI0dDVuREQreU",
"nextCursor": "bmV4dA.bHVlIjoieGJVS0UvYkRjQmZsY1pUbGJCc",
"page": {
"count": 5,
"start": 5
}
}
}