v1
ApplicationAPI & CLI
Double column
API
CLI
JS Client

Tags /

Get tag

View details for a given resource tag.

Required permission

Account > Tags > General > Read

Path parameters

    • resourceTagId

      string required

      ID of the tag

Response body

  • {object}

    Response object.

    • data

      {object} required

      Result data.

      • useSpotNodes

        boolean

        Schedule workloads to spot nodes

      • useOnDemandNodes

        boolean

        Also allow workloads to schedule to on demand nodes. Only relevant if you want workloads to schedule across both spot and on demand nodes

      • nodeAffinities

        [array]
        • {object}

          • preference

            boolean

          • weight

            number

            The node affinity weight. Required when preference is true.

            min
            1
            max
            100

          • matchExpressions

            [array] required
            • {object}

              • key

                string required

              • operator

                string required
                one of
                In, NotIn

              • values

                [array] required
                • string

      • color

        string
        pattern
        ^#([a-fA-F0-9]{6}|[a-fA-F0-9]{3})$

      • description

        string
        max length
        200
        pattern
        ^[a-zA-Z0-9.,?\s\\/'"()[\];`%^&*\-_:!]+$

      • name

        string required
        min length
        3
        max length
        100
        pattern
        ^[a-zA-Z0-9]+((-|\s)[a-zA-Z0-9]+)*$

      • id

        string required
        min length
        3
        max length
        100
        pattern
        ^[a-zA-Z0-9]+(-[a-zA-Z0-9]+)*$

      • createdAt

        string

        time of creation

API
CLI
JS Client

GET /v1/tags/{resourceTagId}

Example response

200 OK

Data about the resource tag.

JSON

{
  "data": {
    "useSpotNodes": false,
    "useOnDemandNodes": false,
    "color": "#57637A",
    "name": "Example Tag",
    "id": "example-tag",
    "createdAt": "2000-01-01T12:00:00.000Z"
  }
}

© 2024 Northflank Ltd. All rights reserved.

northflank.comTermsPrivacyfeedback@northflank.com