Skip to main content

ClusterNodesListResponse

statusboolean

Whether the request succeeded.

Example: true
messagestring

Human-readable description of the result.

Example: Cluster nodes retrieved successfully
nodes object[]

Nodes currently in the cluster.

  • Array [
  • idinteger

    Unique numeric identifier for the node.

    Example: 3287
    rolestring

    Role of the node within the cluster.

    Example: bastion
    node_group_idintegernullable

    Identifier of the node group the node belongs to.

    node_group_namestringnullable

    Name of the node group the node belongs to.

    instance object

    VM instance backing the node.

    idinteger

    Unique numeric identifier for the VM instance.

    Example: 7613
    namestring

    Name of the VM instance.

    Example: example-c1-bastion-0
    statusstring

    Current status of the VM instance.

    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 does 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.
    Example: CREATING
    fixed_ipstringnullable

    Fixed (private) IP address assigned to the VM in its environment.

    Example: 192.0.2.42
    floating_ipstringnullable

    Floating (public) IP address attached to the VM, or null if none.

    Example: 192.0.2.91
    floating_ip_statusstringnullable

    Status of the floating IP address.

    Example: ATTACHING
    contract_idintegernullable

    Identifier of the contract the VM instance is billed under, or null if none.

    image_idinteger

    Identifier of the operating system image installed on the VM instance.

    Example: 7613
    statusstring

    Provisioning status of the node.

    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.
    Example: CREATING
    status_reasonstring

    Human-readable message explaining the node's current status.

    Example: VM is creating
    is_bastionboolean

    Whether the node acts as a bastion host.

    Example: true
    requires_public_ipboolean

    Whether the node is configured to use a public IP.

    Example: true
    created_atstring<date-time>

    ISO 8601 UTC timestamp marking when the node was created.

    Example: 2026-05-06T16:04:09Z
    updated_atstring<date-time>

    ISO 8601 UTC timestamp marking when the node was last updated.

    Example: 2026-05-06T16:04:09Z
  • ]
  • ClusterNodesListResponse
    {
    "status": true,
    "message": "Cluster nodes retrieved successfully",
    "nodes": [
    {
    "id": 3287,
    "role": "bastion",
    "node_group_id": 0,
    "node_group_name": "string",
    "instance": {
    "id": 7613,
    "name": "example-c1-bastion-0",
    "status": "CREATING",
    "fixed_ip": "192.0.2.42",
    "floating_ip": "192.0.2.91",
    "floating_ip_status": "ATTACHING",
    "contract_id": 0,
    "image_id": 7613
    },
    "status": "CREATING",
    "status_reason": "VM is creating",
    "is_bastion": true,
    "requires_public_ip": true,
    "created_at": "2026-05-06T16:04:09Z",
    "updated_at": "2026-05-06T16:04:09Z"
    }
    ]
    }