v1
ApplicationAPI & CLI
Double column
API
CLI
JS Client

Tags /

Update tag

Patch a resource tag.

Required permission

Account > Tags > General > Update

Path parameters

    • resourceTagId

      string required
      ID of the tag

Request body

  • {object}

    • 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\\/'"()[\];`%^&*\-_:!]+$

Response body

  • {object}
    Response object.

    • data

      {object} required
      Result data.
    API
    CLI
    JS Client

    PATCH /v1/tags/{resourceTagId}

    Example request

    Request body
    curl
    curl --header "Content-Type: application/json" \
  --header "Authorization: Bearer NORTHFLANK_API_TOKEN" \
  --request PATCH \
  --data '{"useSpotNodes":false,"useOnDemandNodes":false,"color":"#57637A"}' \
  https://api.northflank.com/v1/tags/{resourceTagId}

    Example response

    200 OK

    The operation was performed successfully.

    JSON

    {
  "data": {}
}

    © 2024 Northflank Ltd. All rights reserved.

    northflank.comTermsPrivacyfeedback@northflank.com