Skip to main content

Cluster Nodes (Scaling)

A set of operations for managing the scaling of Kubernetes clusters.

Endpoint NameURLDescription
Create Nodes /core/clusters/nodesAdds node(s) to an existing cluster.
Retrieve NodesGET /core/clusters/{id}/nodesRetrieves the details of a clusters nodes.
Delete NodeDELETE /core/clusters/{id}/nodesRemoves a node from a specified cluster.

The node object

Node endpoints return the nodes object(s), offering comprehensive details about your cluster nodes.


Attributes of the node object


id integer

The unique identifier assigned to the node.


instance object

The details of the VM instance associated with the node.

Show child attributes
id string

The ID of the virtual machine (VM) instance.


name string

The name of the VM instance.


status string

The current status of the VM instance.

Possible values:
StatusDescription
CREATINGThe VM is being created and initialized.
WAITINGWaiting for public IP assignment to establish connectivity to the VMs through the bastion node.
RECONCILINGKubernetes components are being installed and configured on the VM.
PRE-ACTIVEThe VM is running, but Kubernetes reconciliation for the cluster is pending. Billing will not begin until the cluster is fully reconciled and the VM enters the ACTIVE state.
ACTIVEThe VM is fully configured and ready to run workloads.

fixed_ip string

The internal (private) IP address assigned to the VM.


floating_ip string|null

The public IP address assigned to the VM, if any. Returns null if not assigned.


floating_ip_status string

Indicates the floating IP assignment status (e.g., NO FLOATING IP).


role string

The role of the node within the cluster.

Possible values:
  • worker – Runs containerized workloads.
  • master – Orchestrates scheduling and manages cluster state.
  • bastion – Provides secure SSH access to the cluster.
  • load-balancer – Distributes traffic to worker nodes.

status string

The provisioning status of the node.

Possible values:
StatusDescription
CREATINGThe node is being created and initialized.
WAITINGWaiting for public IP assignment to establish connectivity to the VMs through the bastion node.
RECONCILINGKubernetes components are being installed and configured on the node.
ACTIVEThe node is fully configured and ready to run workloads.

status_reason string

A brief explanation of the node’s current status.


is_bastion boolean

Indicates if the node acts as a bastion host (true or false).


requires_public_ip boolean

Indicates whether the node is configured to use a public IP (true or false).


created_at date-time

Timestamp of when the node was created.


updated_at date-time

Timestamp of the last update to the node.


Response
{
"id": 3096,
"instance": {
"id": "8406",
"name": "kube-example-cluster-b4b817-worker-0",
"status": "ACTIVE",
"fixed_ip": "10.0.1.76",
"floating_ip": null,
"floating_ip_status": "NO FLOATING IP"
},
"role": "worker",
"status": "ACTIVE",
"status_reason": "Node is reconciled",
"is_bastion": false,
"requires_public_ip": false,
"created_at": "2025-04-10T12:35:13",
"updated_at": "2025-04-10T12:47:03"
}

Back to top