Skip to main content

Create tag

POST /v1/tags

Create a new tag, optionally with config overrides.

Token scope required: tags:create

Request

Request Body required
  • name key:value required

    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.

  • description string

    Possible values: <= 255 characters

    Optional description

  • configOverrides object[]

    List of config overrides for the nebula config

  • Array [
  • anyOf
  • key string required

    Possible values: [lighthouse.dns.host]

  • value string required
  • ]
  • before key:value

    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."

  • after key:value

    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."

  • Responses

    Successful operation

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

  • metadata object
  • Loading...