TEtetrate
Clusters

Get the last known state for an onboarded cluster. Once a cluster has been onboarded into the platform, the agents will keep it up to date with its runtime status. Getting the cluster object will return the last known snapshot of existing namespaces and services running in it.

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

Request

Path parameters

organizationstring required

Organization name.

clusterstring required

Cluster name.

Query parameters

fetchWorkloadsboolean

Flag to fetch the workload information as well. Note that by default workload information is not returned as it may be expensive to retrieve.

includeInstallTemplateboolean

Flag to return the install template required to install this cluster. This will generate a new API key pair for the cluster service account.

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.