Skip to main content
GET
/
v1
/
regions
/
{region}
/
projects
/
{project}
/
compute
/
clusters
/
{id}
Get cluster details
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.k0rdent.ai/v1/regions/{region}/projects/{project}/compute/clusters/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
{
  "selfLink": "/v1/regions/us-texas-1/projects/project-x9y8z7/compute/clusters/cluster-a1b2c3",
  "uid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "id": "cluster-a1b2c3",
  "displayName": "<string>",
  "description": "<string>",
  "nodePools": [
    "<unknown>"
  ],
  "status": {
    "phase": "<string>",
    "conditions": [
      {}
    ]
  },
  "nodeCount": 123,
  "kubernetesVersion": "<string>",
  "endpoint": {
    "url": "<string>",
    "caCertificate": "<string>"
  },
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z"
}

Authorizations

​
Authorization
string
header
required

Bearer token authentication using OAuth2/OIDC tokens

Path Parameters

​
region
string
required

Region identifier

​
project
string
required

Project identifier

​
id
string
required

Unique cluster identifier

Response

Cluster details

Kubernetes cluster resource.

​
selfLink
string<uri>

Server-defined URL for this resource.

Example:

"/v1/regions/us-texas-1/projects/project-x9y8z7/compute/clusters/cluster-a1b2c3"

​
uid
string<uuid>

Server-generated UUID.

​
id
string

Name of the resource. Provided by the client when the resource is created, or generated by the server if not specified. Must be 1-63 characters long and match the pattern a-z? — the first character must be a lowercase letter, and all following characters must be lowercase letters, digits, or hyphens, with the last character being a letter or digit. Cannot be changed after the resource is created.

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

"cluster-a1b2c3"

​
displayName
string

Optional human-friendly display name for the cluster.

​
description
string

An optional description of this resource.

​
nodePools
any[]

Node pools belonging to this cluster.

​
status
object

Cluster health and readiness state.

​
nodeCount
integer

Number of nodes in cluster.

​
kubernetesVersion
string

Kubernetes version.

​
endpoint
object

Cluster endpoint details.

​
createdAt
string<date-time>
​
updatedAt
string<date-time>