Skip to main content
PATCH
Change cluster labels

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

x-ankra-organisation-id
string

PAT organisation override.

Path Parameters

cluster_id
string<uuid>
required

Body

application/json

A change to a cluster's labels. At least one of set and remove must name something, and no key may appear in both.

set
object

Labels to add or overwrite, key to value.

remove
string[]

Label keys to remove.

Response

Successful response

The labels on one cluster.

cluster_id
string<uuid>
required
labels
object
required

The cluster's labels, key to value.

environment
string | null
required

The cluster's own environment, which dynamic groups select on under the reserved environment key. Changed on the cluster, never through labels.

reserved_keys
string[]
required

Keys no label may carry.