> This page is for NVIDIA Kubernetes Engine.

> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.nvidia.com/nvke/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.nvidia.com/nvke/_mcp/server.

# List nodes

GET https://nvke.acme.example/api/nodes

Returns all nodes, filtered by the query parameters. All filters are exact match.

Reference: https://docs.nvidia.com/nvke/rest-api-reference/nodes/list-nodes

## Authentication

- `Authorization` header (bearer token, required) — A JWT from an issuer the Operator has configured, carried as `Authorization: Bearer <token>`.

## Request

### Query parameters

- `clusterID` (string, optional) — Filter by cluster ID
- `nodePoolID` (string, optional) — Filter by node pool ID
- `clusterName` (string, optional) — Filter by cluster name (exact match)
- `name` (string, optional) — Filter by node name (exact match)
- `controlPlane` (boolean, optional) — `true` returns only control-plane nodes; `false` only workers

## Response

### 200

A list of nodes

- `nodes` (list of Node, required) — Nodes.

## Errors

### 401 Unauthorized Error

No valid bearer token was presented.

- `message` (string, required) — What went wrong.

### 403 Forbidden Error

The token verified, but its subject matches no admission rule.

- `message` (string, required) — What went wrong.

## Types

### Node

A single machine in a cluster, with lifecycle and health conditions.

- `id` (string, required) — Node ID.
- `nodePoolID` (string, required) — Owning node pool. The nil UUID for control-plane nodes.
- `nodeSetID` (string, required) — Owning NodeSet. The nil UUID for control-plane nodes.
- `name` (string, required) — Node name.
- `controlPlane` (boolean, required) — Whether the node is a control-plane node.
- `conditions` (NodeConditions, required) — Lifecycle and health conditions.
- `ip` (string, optional) — Node IP address.
- `nico` (NicoNodeProvider, optional) — NICo instanceID, machineID and instanceTypeID. Omitted when none are set.
- `launchLayer` (LaunchLayerNodeProvider, optional) — LaunchLayer instanceID, machineID and rackID. Omitted when none are set.
- `controlPlaneRollout` (ControlPlaneRolloutStatus, optional) — Control-plane nodes only.

### NodeConditions

Each is a Condition. A node normally moves through pending, provisioningClaimed, provisioning, readyToJoin, joined and provisioned; deletion moves through deleteRequested (control-plane nodes) and deleting.

- `pending` (Condition, required) — The node is waiting to be provisioned.
- `provisioningClaimed` (Condition, required) — A provisioning operation has claimed the node.
- `provisioning` (Condition, required) — The node is provisioning.
- `readyToJoin` (Condition, required) — The node is ready to join the cluster.
- `joined` (Condition, required) — The node has joined the cluster.
- `provisioned` (Condition, required) — The node is provisioned.
- `deleting` (Condition, required) — The node is being deleted.
- `kubernetesReady` (Condition, required) — The kubelet reports Ready.
- `kubernetesUnschedulable` (Condition, required) — Reflects the Kubernetes node's unschedulable (cordoned) state.
- `nodeAgentReady` (Condition, required) — The NVKE node agent is healthy.
- `rebooting` (Condition, required) — The node is rebooting.
- `markedForRecycling` (Condition, required) — The node is marked for replacement.
- `markedForRepair` (Condition, required) — The node is marked for repair.
- `deleteRequested` (Condition, required) — A delete has been accepted but teardown has not started. Control-plane deletes are recorded here first and started one at a time; `deleting` then reports the teardown. At most one of deleting and deleteRequested is True.
- `controlPlaneRolloutRequired` (Condition, optional) — Control-plane nodes only. True when the node differs from the desired configuration.

### NicoNodeProvider

NICo identifiers of the machine behind a node. Omitted when none of its fields are set.

- `instanceID` (string, optional) — NICo instance ID.
- `machineID` (string, optional) — NICo machine ID.
- `instanceTypeID` (string, optional) — NICo instance type the node was provisioned with.

### LaunchLayerNodeProvider

LaunchLayer identifiers of the instance behind a node, reported by CAPLL on LaunchLayerMachine.status. Omitted when none of its fields are set — a node not yet provisioned has none of them.

- `instanceID` (string, optional) — LaunchLayer Compute instance ID.
- `machineID` (string, optional) — Physical machine the instance landed on. Empty for a virtual instance.
- `rackID` (string, optional) — Rack the instance landed in. Populated for both virtual and physical instances.

### ControlPlaneRolloutStatus

Control-plane nodes only. Drift is computed on the release and the Kubernetes version. Resolve pinnedConfigurationID and desiredConfigurationID with GET /clusters/\{clusterID}/control-plane/configHistory.

- `pending` (boolean, required) — The node differs from the desired configuration.
- `actionable` (boolean, required) — The node can be replaced now.
- `changes` (list of ControlPlaneRolloutChange, optional) — Each with field, from, to as plain strings. Drift is computed on the release and the Kubernetes version.
- `pinnedConfigurationID` (string, optional) — Configuration the node was built from.
- `desiredConfigurationID` (string, optional) — Configuration the node should move to.

### Condition

A status, when it last changed, and a message.

- `status` (enum, required) — Condition status.
  - Allowed values: `True`, `False`, `Unknown`
- `lastTransitionTime` (datetime, required) — When the status last changed.
- `message` (string, required) — Human-readable detail. May be empty.

### ControlPlaneRolloutChange

One rollout-relevant field whose pinned value differs from the desired value, as plain strings.

- `field` (string, required) — The rollout-relevant field that changed (e.g. kubernetesVersion, release).
- `from` (string, required) — The value the node is currently pinned to.
- `to` (string, required) — The cluster's desired value.

## Examples

**Request**

```json
{}
```

**Response**

```json
{
  "nodes": [
    {
      "id": "a3f1c2d4-5e6b-7890-abcd-ef1234567890",
      "nodePoolID": "00000000-0000-0000-0000-000000000000",
      "nodeSetID": "00000000-0000-0000-0000-000000000000",
      "name": "tenant-a-prod-w-0001",
      "controlPlane": true,
      "conditions": {
        "pending": {
          "status": "False",
          "lastTransitionTime": "2024-03-15T08:00:00Z",
          "message": "Node is no longer pending"
        },
        "provisioningClaimed": {
          "status": "True",
          "lastTransitionTime": "2024-03-15T08:01:30Z",
          "message": "Provisioning operation claimed by controller"
        },
        "provisioning": {
          "status": "False",
          "lastTransitionTime": "2024-03-15T08:12:45Z",
          "message": "Provisioning completed successfully"
        },
        "readyToJoin": {
          "status": "True",
          "lastTransitionTime": "2024-03-15T08:13:00Z",
          "message": "Node passed pre-join checks"
        },
        "joined": {
          "status": "True",
          "lastTransitionTime": "2024-03-15T08:14:22Z",
          "message": "Node successfully joined the cluster"
        },
        "provisioned": {
          "status": "True",
          "lastTransitionTime": "2024-03-15T08:15:00Z",
          "message": "Node is fully provisioned"
        },
        "deleting": {
          "status": "False",
          "lastTransitionTime": "2024-03-15T08:15:00Z",
          "message": ""
        },
        "kubernetesReady": {
          "status": "True",
          "lastTransitionTime": "2024-03-15T08:16:10Z",
          "message": "kubelet reports node Ready"
        },
        "kubernetesUnschedulable": {
          "status": "False",
          "lastTransitionTime": "2024-03-15T08:16:10Z",
          "message": ""
        },
        "nodeAgentReady": {
          "status": "True",
          "lastTransitionTime": "2024-03-15T08:16:30Z",
          "message": "NVKE node agent is healthy"
        },
        "rebooting": {
          "status": "False",
          "lastTransitionTime": "2024-03-15T08:15:00Z",
          "message": ""
        },
        "markedForRecycling": {
          "status": "False",
          "lastTransitionTime": "2024-03-15T08:15:00Z",
          "message": ""
        },
        "markedForRepair": {
          "status": "False",
          "lastTransitionTime": "2024-03-15T08:15:00Z",
          "message": ""
        },
        "deleteRequested": {
          "status": "False",
          "lastTransitionTime": "2024-03-15T08:15:00Z",
          "message": ""
        },
        "controlPlaneRolloutRequired": {
          "status": "True",
          "lastTransitionTime": "2024-03-20T14:00:00Z",
          "message": "Node differs from desired configuration: kubernetesVersion changed"
        }
      },
      "ip": "10.0.1.42",
      "nico": {
        "instanceID": "nico-inst-7f3a2b1c",
        "machineID": "nico-mach-4d8e9f0a",
        "instanceTypeID": "b2e4f6a8-1c3d-4e5f-9a0b-7c8d9e0f1a2b"
      },
      "launchLayer": {
        "instanceID": "ll-inst-9c2d4e6f",
        "machineID": "ll-mach-1a3b5c7d",
        "rackID": "rack-us-east-1a-07"
      },
      "controlPlaneRollout": {
        "pending": true,
        "actionable": true,
        "changes": [
          {
            "field": "kubernetesVersion",
            "from": "1.29.2",
            "to": "1.30.1"
          }
        ],
        "pinnedConfigurationID": "c1d2e3f4-a5b6-7890-cdef-012345678901",
        "desiredConfigurationID": "d4e5f6a7-b8c9-0123-def0-123456789abc"
      }
    }
  ]
}
```

**SDK Code**

```python
import requests

url = "https://nvke.acme.example/api/nodes"

payload = {}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.get(url, json=payload, headers=headers)

print(response.json())
```

```javascript
const url = 'https://nvke.acme.example/api/nodes';
const options = {
  method: 'GET',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://nvke.acme.example/api/nodes"

	payload := strings.NewReader("{}")

	req, _ := http.NewRequest("GET", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://nvke.acme.example/api/nodes")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{}"

response = http.request(request)
puts response.read_body
```

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.get("https://nvke.acme.example/api/nodes")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{}")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://nvke.acme.example/api/nodes', [
  'body' => '{}',
  'headers' => [
    'Authorization' => 'Bearer <token>',
    'Content-Type' => 'application/json',
  ],
]);

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("https://nvke.acme.example/api/nodes");
var request = new RestRequest(Method.GET);
request.AddHeader("Authorization", "Bearer <token>");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = [
  "Authorization": "Bearer <token>",
  "Content-Type": "application/json"
]
let parameters = [] as [String : Any]

let postData = JSONSerialization.data(withJSONObject: parameters, options: [])

let request = NSMutableURLRequest(url: NSURL(string: "https://nvke.acme.example/api/nodes")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```