Skip to main content
GET
Get kubernetes cluster details

Authorizations

Authorization
string
header
required

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

Path Parameters

project_id
string
required

ID of the project

Pattern: ^pj[0-9a-hj-km-np-tv-z]{24}$
Example:

"pjkkmx0f2vke4h36nk9cm8v8q0"

location
string
required

The Ubicloud location/region

Example:

"eu-central-h1"

kubernetes_cluster_reference
string
required

Kubernetes cluster ID or name Resource ID or name

Pattern: ^[a-z0-9](?:[a-z0-9\-]{0,61}[a-z0-9])?$

Response

A KubernetesCluster

cp_node_count
integer
required

Number of control plane nodes

id
string
required

ID of the KubernetesCluster

Pattern: ^kc[0-9a-hj-km-np-tv-z]{24}$
Example:

"kcqxhqbg86sj0ng5e9ck5n191z"

location
string
required

Location of the KubernetesCluster

Example:

"eu-central-h1"

name
string
required

Name of the KubernetesCluster

Example:

"my-cluster-name"

node_size
string
required

Size of each control plane node

version
string
required

Version of the KubernetesCluster

cp_vms
object[]
display_state
string

State of the KubernetesCluster

nodepools
object[]
services_load_balancer_url
string | null

Services