TEtetrate
Clusters

Modify an existing cluster. Updates a cluster with the given data. Note that most of the data in the cluster is read-only and automatically populated by the local cluster agents.

put/v2/organizations/{organization}/clusters/{cluster}

Request

Path parameters

organizationstring required

Organization name.

clusterstring required

Cluster name.

Request body

descriptionstring
displayNamestring
etagstring
labelsobject
networkstring

The network (e.g., VPC) where this cluster is present. All clusters within the same network will be assumed to be reachable for the purposes of multi-cluster routing. In addition, networks marked as reachable from one another in SystemSettings will also be used for multi-cluster routing.

tier1Clusterboolean

Indicates whether this cluster is hosting a tier1 gateway or not. Tier1 clusters cannot host other gateways or workloads. Defaults to false if not specified.

tokenTtlstring

Lifetime of the tokens. Defaults to 1hr.

trustDomainstring

Trust domain for this cluster, used for multi-cluster routing. It must be unique for every cluster and should match the one configured in the local control plane. This value is optional, and will be updated by the local control plane agents. However, it is recommended to set it, if known, so that multi-cluster routing works without having to wait for the local control planes to update it.

Response

A successful response.

fqnstring
displayNamestring
etagstring
descriptionstring
tokenTtlstring

Lifetime of the tokens. Defaults to 1hr.

networkstring

The network (e.g., VPC) where this cluster is present. All clusters within the same network will be assumed to be reachable for the purposes of multi-cluster routing. In addition, networks marked as reachable from one another in SystemSettings will also be used for multi-cluster routing.

tier1Clusterboolean

Indicates whether this cluster is hosting a tier1 gateway or not. Tier1 clusters cannot host other gateways or workloads. Defaults to false if not specified.

labelsobject
trustDomainstring

Trust domain for this cluster, used for multi-cluster routing. It must be unique for every cluster and should match the one configured in the local control plane. This value is optional, and will be updated by the local control plane agents. However, it is recommended to set it, if known, so that multi-cluster routing works without having to wait for the local control planes to update it.

Changes

No recorded changes to this operation across all 3 revisions of this API.