Clusters

A set of operations for creating and managing Kubernetes clusters.

Endpoint Name	URL	Description
Create Cluster	POST /core/clusters	Creates a Kubernetes cluster.
List Clusters	GET /core/clusters	Retrieves a list of your clusters along with their details.
Retrieve Cluster Details	GET /core/clusters/{id}	Retrieves the details of a specified cluster.
Delete Cluster	DELETE /core/clusters/{id}	Deletes a specified cluster.
List Cluster Versions	GET /core/clusters/versions	Retrieves a list of compatible Kubernetes versions.
Verify Cluster Name Availability	GET /core/clusters/name-availability/{cluster_name}	Verifies the availabity of the specified cluster name.
Retrieve Cluster Events	GET /core/clusters/{id}/events	Retrieves a list of events for a specified cluster.

---

The clusters object

Clusters endpoints return the clusters object(s), offering comprehensive details about your clusters.

Attributes of the clusters object

id integer

The unique identifier assigned to the cluster.

---

name string

The name of the Kubernetes cluster.

---

environment name string

The name of the environment where the cluster is deployed.

---

kubernetes_version string

The version of Kubernetes running on the cluster.

---

kube_config string

A string representing the kubeconfig file contents required for connecting to the cluster.

---

status string

The current status of the Kubernetes cluster.

Possible values:

• CREATING: The cluster is being created.
• ACTIVE: The cluster is active and operational.
• ERROR: An error occurred during cluster creation or operation. Check the status_reason field for more details.

---

status_reason string

A message providing information about the status of the cluster, particularly useful in case of errors.

---

node_count number

The number of nodes (virtual machines) in the cluster.

---

node_flavor object

Details about the flavor (hardware configuration) of the nodes in the cluster.

Click here to see attributes

name string

The model name of the VM configuration.

---

cpu integer

The number of CPU cores.

---

ram number

The amount of RAM in GB.

---

disk integer

The size of the primary disk in GB.

---

ephemeral integer

The size of the ephemeral storage in GB.

---

gpu string

The GPU model.

---

gpu_count integer

The number of GPUs.

---

node_addresses array of strings

A list of public IP addresses assigned to the nodes in the cluster.

---

keypair_name string

The name of the key pair used for SSH access to the nodes.

---

created_at datetime

The date and time when the cluster was created.

Response

{
  "id": 1,
  "name": "example-cluster",
  "environment_name": "example-environment",
  "kubernetes_version": "1.27.8",
  "kube_config": "",
  "status": "ACTIVE",
  "status_reason": String,
  "node_count": 3,
  "node_flavor": {
    "name": "n3-A100x1",
    "cpu": 28,
    "ram": 120.0,
    "disk": 100,
    "ephemeral": 750,
    "gpu": "A100-80G-PCIe",
    "gpu_count": 1
  },
  "node_addresses": [""],
  "keypair_name": "example-ssh-key",
  "created_at": "2024-06-17T09:33:46",
},

Back to top