> 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 node pools

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

Returns all node pools, filtered by the query parameters.

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

## 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
- `clusterName` (string, optional) — Filter by cluster name (exact match)
- `name` (string, optional) — Filter by node pool name (exact match)

## Response

### 200

A list of node pools

- `nodePools` (list of NodePool, required) — Node pools.

## 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

### NodePool

A group of worker nodes sharing an instance type, release and Kubernetes version.

- `id` (string, required) — Node pool ID.
- `clusterID` (string, required) — Parent cluster.
- `name` (string, required) — Node pool name. Unique within the cluster. Immutable.
- `nodeNamePrefix` (string, required) — Node names are `<cluster>-<prefix>-<NNNN>` (four-digit suffix), at most 63 characters in total.
- `kubernetesVersion` (string, required) — Desired Kubernetes version for the pool's nodes. Inherits the cluster's version on create.
- `nodeLabels` (map from string to string, required) — Labels applied to the pool's nodes, as a map of keys to values. Set at creation.
- `nodeTaints` (list of NodeTaint, required) — Taints applied to the pool's nodes. Set at creation.
- `conditions` (NodePoolConditions, required) — Lifecycle conditions: provisioning, provisioned, deleting.
- `desiredNodeCount` (integer, required) — Number of nodes.
- `autoProvisionDisabled` (boolean, required) — Disables automatic provisioning for the pool.
- `currentNodeSetID` (string, required, nullable) — The active NodeSet.
- `autoModeDisabled` (boolean, required) — Disables auto-mode (automatic node recycling).
- `provisioningMonitorDisabled` (boolean, required, default: false) — When true, nodes stuck in provisioning past the timeout are not recycled automatically.
- `recycleBudget` (integer, required) — Maximum number of nodes recycled at once.
- `systemReservedMemory` (string, optional, default: 16Gi) — Memory reserved for system daemons. Nodes reserve 16Gi when omitted.
- `kubeReservedMemory` (string, optional) — Memory reserved for Kubernetes components. Empty when the 2Gi default applies.
- `machineAnnotations` (map from string to string, optional) — Annotations set on CAPI Machines only when they are created, including Machines created during scale-out or replacement. Fixed at node-pool creation. Not reconciled after provisioning. Keys under nke.nvidia.com, nke.io, nvke.nvidia.com, kubernetes.io, k8s.io, cluster.x-k8s.io and their subdomains require an explicit deployment allowlist entry for this metadata type.
- `machineLabels` (map from string to string, optional) — Labels set on CAPI Machines only when they are created, including Machines created during scale-out or replacement. Fixed at node-pool creation. Not reconciled after provisioning. Keys under nke.nvidia.com, nke.io, nvke.nvidia.com, kubernetes.io, k8s.io, cluster.x-k8s.io and their subdomains require an explicit deployment allowlist entry for this metadata type.
- `description` (string, optional) — Free-text description.
- `maxSurge` (integer, optional, default: 0) — Nodes allowed above desiredNodeCount during a rollout. 0 means sequential: each node is torn down before its replacement is provisioned.
- `nico` (NicoNodePoolProvider, optional) — NICo settings for the pool.
- `launchLayer` (LaunchLayerNodePoolProvider, optional) — LaunchLayer settings for the pool.

### NodeTaint

A Kubernetes taint applied to nodes in a pool.

- `key` (string, required) — Taint key.
- `effect` (enum, required) — Kubernetes taint effect.
  - Allowed values: `NoSchedule`, `PreferNoSchedule`, `NoExecute`
- `value` (string, optional) — Taint value. Empty is valid.

### NodePoolConditions

Lifecycle conditions of a node pool. Each is a Condition.

- `provisioning` (Condition, required) — The node pool is provisioning.
- `provisioned` (Condition, required) — The node pool is provisioned.
- `deleting` (Condition, required) — The node pool is being deleted.

### NicoNodePoolProvider

NICo settings for a node pool. instanceTypeID and release are required, and exactly one of subnetIDs and vpcPrefixIDs is required.

- `subnetIDs` (list of string, optional) — Subnets, for sites without native networking.
- `vpcPrefixIDs` (list of string, optional) — VPC prefixes, for sites with native networking.
- `instanceTypeID` (string, optional) — NICo instance type. Fixed at creation.
- `infinibandPartitionID` (string, optional) — InfiniBand partition. Fixed at creation.
- `nvLinkLogicalPartitionID` (string, optional) — NVLink logical partition. Fixed at creation.
- `sshKeyGroupIDs` (list of string, optional) — SSH key groups for node access. Fixed at creation.
- `release` (string, optional) — Name of a release the Operator has supplied to the management plane.
- `diskSelectionStrategy` (enum, optional) — Which disk the OS is installed on. Default smallest.
  - Allowed values: `smallest`, `largest`

### LaunchLayerNodePoolProvider

LaunchLayer settings for a node pool. instanceType is required, and at most one of hostOSProfile and vmProfile may be set.

- `instanceType` (string, required) — Requests capacity of a given shape, for example "vm200".
- `hostOSProfile` (string, optional) — Bare-metal profile, as "\<name>" or "\<name>:\<version>". Mutually exclusive with vmProfile.
- `vmProfile` (string, optional) — Virtual profile, as "\<name>" or "\<name>:\<version>". Mutually exclusive with hostOSProfile.
- `fulfillmentStrategy` (enum, optional) — Controls how the Compute Allocation Operator places the request.
  - Allowed values: `BEST_EFFORT`, `ALL_OR_NOTHING`, `WAIT_FOR_RESOURCE`
- `securityGroupRefs` (LaunchLayerSecurityGroupRefs, optional) — Names of the owning cluster's managed security groups to attach, per network interface. Mutually exclusive with securityGroups (existing group IDs) per interface — CAPLL supports both but NVKE always creates groups through the cluster, so NVKE only exposes refs.

### 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.

### LaunchLayerSecurityGroupRefs

Names of the owning cluster's managed security groups to attach, per network interface. Mutually exclusive with securityGroups (existing group IDs) per interface — CAPLL supports both but NVKE always creates groups through the cluster, so NVKE only exposes refs.

- `primaryNetworkInterface` (list of string, optional) — Managed security group names to attach to the primary network interface.
- `gpuNetworkInterface` (list of string, optional) — Managed security group names to attach to the GPU network interface.

## Examples

**Request**

```json
{}
```

**Response**

```json
{
  "nodePools": [
    {
      "id": "a3bb189e-8bf9-3888-9912-ace4e6543002",
      "clusterID": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
      "name": "gpu-workers",
      "nodeNamePrefix": "gpu",
      "kubernetesVersion": "1.29.4",
      "nodeLabels": {},
      "nodeTaints": [
        {
          "key": "nvidia.com/gpu",
          "effect": "NoSchedule",
          "value": "present"
        }
      ],
      "conditions": {
        "provisioning": {
          "status": "False",
          "lastTransitionTime": "2024-03-15T10:00:00Z",
          "message": "Node pool provisioning completed successfully"
        },
        "provisioned": {
          "status": "True",
          "lastTransitionTime": "2024-03-15T10:15:00Z",
          "message": "All nodes are provisioned and ready"
        },
        "deleting": {
          "status": "False",
          "lastTransitionTime": "2024-03-15T10:15:00Z",
          "message": ""
        }
      },
      "desiredNodeCount": 4,
      "autoProvisionDisabled": false,
      "currentNodeSetID": "c2d3e4f5-1234-5678-9abc-def012345678",
      "autoModeDisabled": false,
      "provisioningMonitorDisabled": false,
      "recycleBudget": 2,
      "systemReservedMemory": "16Gi",
      "kubeReservedMemory": "2Gi",
      "machineAnnotations": {},
      "machineLabels": {},
      "description": "GPU worker node pool for AI/ML workloads",
      "maxSurge": 1,
      "nico": {
        "subnetIDs": [
          "d1e2f3a4-b5c6-7890-abcd-ef1234567890"
        ],
        "vpcPrefixIDs": [
          "e2f3a4b5-c6d7-8901-bcde-f12345678901"
        ],
        "instanceTypeID": "b5c6d7e8-f9a0-1234-5678-90abcdef1234",
        "infinibandPartitionID": "c6d7e8f9-a0b1-2345-6789-0abcdef12345",
        "nvLinkLogicalPartitionID": "d7e8f9a0-b1c2-3456-789a-bcdef0123456",
        "sshKeyGroupIDs": [
          "e8f9a0b1-c2d3-4567-89ab-cdef01234567"
        ],
        "release": "example-ubuntu-24.04-amd64",
        "diskSelectionStrategy": "smallest"
      },
      "launchLayer": {
        "instanceType": "vm200",
        "hostOSProfile": "ubuntu-24.04-baremetal:1.2.0",
        "vmProfile": "",
        "fulfillmentStrategy": "BEST_EFFORT",
        "securityGroupRefs": {
          "primaryNetworkInterface": [
            "default-workers-sg"
          ],
          "gpuNetworkInterface": [
            "gpu-network-sg"
          ]
        }
      }
    }
  ]
}
```

**SDK Code**

```python
import requests

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

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/nodePools';
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/nodePools"

	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/nodePools")

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/nodePools")
  .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/nodePools', [
  'body' => '{}',
  'headers' => [
    'Authorization' => 'Bearer <token>',
    'Content-Type' => 'application/json',
  ],
]);

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

```csharp
using RestSharp;

var client = new RestClient("https://nvke.acme.example/api/nodePools");
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/nodePools")! 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()
```