Skip to main content
PATCH
Rename a cluster

Authorizations

Authorization
string
header
required

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

Path Parameters

cluster_id
string<uuid>
required

Body

application/json
name
string
required

The new name: 1 to 53 lowercase letters, digits and hyphens, starting with a letter and ending with a letter or digit

Required string length: 1 - 53
Pattern: ^[a-z]([-a-z0-9]*[a-z0-9])?$

Response

The cluster's name after the write and the name it had before

changed
boolean
required

False when the cluster already had the name; nothing was written

cluster_id
string<uuid>
required
iac_directory
string
required

The GitOps directory the cluster resolves to, the same before and after the rename

name
string
required
previous_name
string
required