Skip to main content

List Nodes in a Node Pool

Returns the worker nodes belonging to a node pool - each node's id, name, status, public and private IP address, vm_type, and timestamps. Use the node pool's service_id (from List).

GET/api/v1/kubernetes/cluster-nodes/{node_pool_id}

Path parameters

  • node_pool_idPathintegerrequired

    The node pool service_id (from List).

    • required
    • must be a valid node pool service ID
    example12346

Query parameters

  • project_idQueryintegerrequired

    Identifier of the project to scope the request to. Required integer project ID.

    • required
    • must be a valid integer project ID
    example{{project_id}}
  • apikeyQuerystringrequired

    API key used to authenticate the request.

    • required
    • non-empty string
    example{{api_key}}
  • locationQuerystringrequired

    Region of the cluster.

    • required
    • must be a valid region name (e.g., Delhi, Chennai)
    example{{location}}

Responses

200Successful response
object
codeinteger
example200
dataarray

Worker nodes in the node pool.

errorsobject
messagestring
exampleSuccess