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

# Get a cluster's control plane

GET https://nvke.acme.example/api/clusters/{clusterID}/control-plane

Read-only view of the control plane: the persisted configuration plus
aggregate runtime status (node counts, current Kubernetes version,
rollout progress, and upgrade and recycling conditions). Change the
control plane through `PATCH /clusters/{clusterID}`.

Reference: https://docs.nvidia.com/nvke/rest-api-reference/control-plane/get-cluster-control-plane

## Authentication

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

## Request

### Path parameters

- `clusterID` (string, required) — Cluster ID.

## Response

### 200

Control-plane configuration and status

- `config` (ControlPlaneConfig, required) — The persisted control-plane configuration.
- `status` (ControlPlaneStatus, required) — Aggregate runtime status.

## Errors

### 404 Not Found Error

Cluster not found. No body is returned.

- `any`

## Types

### ControlPlaneConfig

The control-plane configuration in effect, including the desired node-agent version.

- `configurationId` (string, optional) — ID of the current configuration snapshot.
- `desiredCount` (integer, optional) — The desired number of cluster-level control plane nodes. Creating a cluster with or increasing this count above 1 requires controlPlaneVIP on the cluster.
- `maxSurge` (integer, optional) — Extra control-plane nodes allowed during a rollout (0 or 1).
- `provisioningMonitorDisabled` (boolean, optional) — When true, nodes stuck in provisioning past the timeout are not replaced automatically.
- `systemReservedMemory` (string, optional) — Memory reserved for system daemons. Nodes reserve 16Gi when omitted.
- `machineAnnotations` (map from string to string, optional) — Annotations applied to control-plane CAPI Machines at creation, including scale-out and replacement Machines. Fixed at cluster creation and 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 applied to control-plane CAPI Machines at creation, including scale-out and replacement Machines. Fixed at cluster creation and 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.
- `nodeLabels` (map from string to string, optional) — Labels applied to control-plane nodes, as a map of keys to values. Set at creation.
- `nico` (NicoControlPlaneProvider, optional) — NICo settings for control-plane nodes.
- `launchLayer` (LaunchLayerControlPlaneProvider, optional) — LaunchLayer settings for control-plane nodes.
- `nodeAgentConfig` (NodeAgentConfig, optional) — Desired control-plane node-agent configuration.

### ControlPlaneStatus

Aggregate runtime status of a cluster's control plane.

- `nodeCount` (integer, required) — Total control-plane nodes, including surge nodes.
- `readyNodeCount` (integer, required) — Control-plane nodes reporting Kubernetes Ready.
- `kubernetesVersion` (string, required) — Current running control-plane Kubernetes version.
- `controlPlaneUpgrading` (Condition, required) — The control plane is being upgraded.
- `cpNodesRecycling` (Condition, required) — Control-plane nodes are being replaced.
- `deletingNodeCount` (integer, required) — Control-plane nodes being torn down. Deletes are serialized, so this is at most 1.
- `deleteRequestedNodeCount` (integer, required) — Control-plane nodes with an accepted delete that has not started.
- `rollout` (ControlPlaneRolloutSummary, optional) — Rollout progress.

### NicoControlPlaneProvider

NICo settings for the control-plane nodes, as reported on read. Requests use NicoControlPlaneProviderCreate and NicoControlPlaneProviderUpdate, which omit the fields that direction cannot set.

- `instanceTypePreference` (list of string, optional) — Ordered list of acceptable NICo instance types; index 0 is the highest priority.
- `subnetIDs` (list of string, optional) — Subnets, for sites without native networking.
- `vpcPrefixIDs` (list of string, optional) — VPC prefixes, for sites with native networking.
- `release` (string, optional) — Name of a release the Operator has supplied to the management plane.
- `diskSelectionStrategy` (enum, optional) — Always smallest for control-plane nodes. Not configurable through the API.
  - Allowed values: `smallest`, `largest`
- `sshKeyGroupIDs` (list of string, optional) — SSH key groups for node access. Can be updated.

### LaunchLayerControlPlaneProvider

LaunchLayer settings for the control-plane nodes. Same shape as LaunchLayerNodePoolProvider — control-plane nodes are still LaunchLayer machines. Fixed at creation.

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

### NodeAgentConfig

Desired control-plane node-agent configuration.

- `version` (string, optional) — Exact agent release version. An empty value disables agent convergence.

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

### ControlPlaneRolloutSummary

Rollout progress of the control plane. The three node counts are mutually exclusive and sum to managedNodeCount.

- `managedNodeCount` (integer, required) — Control-plane nodes under management.
- `upToDateNodeCount` (integer, required) — Nodes on the desired configuration.
- `pendingNodeCount` (integer, required) — Nodes waiting to be replaced.
- `inProgressNodeCount` (integer, required) — Nodes being replaced. The three counts sum to managedNodeCount.
- `inProgress` (boolean, required) — A rollout is running.
- `recyclingEnabled` (boolean, required) — When false, pending nodes are detected but wait for an operator.

### 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
{
  "config": {
    "configurationId": "a3bb189e-8bf9-3888-9912-ace4e6543002",
    "desiredCount": 3,
    "maxSurge": 1,
    "provisioningMonitorDisabled": false,
    "systemReservedMemory": "16Gi",
    "machineAnnotations": {},
    "machineLabels": {},
    "nodeLabels": {},
    "nico": {
      "instanceTypePreference": [
        "c1f2a3b4-d5e6-7890-abcd-ef1234567890"
      ],
      "subnetIDs": [
        "d4e5f6a7-b8c9-4012-bcde-f01234567891"
      ],
      "vpcPrefixIDs": [
        "e5f6a7b8-c9d0-4123-cdef-012345678912"
      ],
      "release": "example-ubuntu-24.04-amd64",
      "diskSelectionStrategy": "smallest",
      "sshKeyGroupIDs": [
        "f6a7b8c9-d0e1-4234-defa-123456789023"
      ]
    },
    "launchLayer": {
      "instanceType": "vm200",
      "hostOSProfile": "ubuntu-24.04-lts",
      "vmProfile": "standard-v2",
      "fulfillmentStrategy": "BEST_EFFORT",
      "securityGroupRefs": {
        "primaryNetworkInterface": [
          "control-plane-primary-sg"
        ],
        "gpuNetworkInterface": [
          "control-plane-gpu-sg"
        ]
      }
    },
    "nodeAgentConfig": {
      "version": "1.4.2"
    }
  },
  "status": {
    "nodeCount": 3,
    "readyNodeCount": 3,
    "kubernetesVersion": "v1.30.2",
    "controlPlaneUpgrading": {
      "status": "False",
      "lastTransitionTime": "2024-06-10T08:15:00Z",
      "message": "Control plane is up to date"
    },
    "cpNodesRecycling": {
      "status": "False",
      "lastTransitionTime": "2024-06-10T08:15:00Z",
      "message": "No control-plane nodes are being recycled"
    },
    "deletingNodeCount": 0,
    "deleteRequestedNodeCount": 0,
    "rollout": {
      "managedNodeCount": 3,
      "upToDateNodeCount": 3,
      "pendingNodeCount": 0,
      "inProgressNodeCount": 0,
      "inProgress": false,
      "recyclingEnabled": true
    }
  }
}
```

**SDK Code**

```python
import requests

url = "https://nvke.acme.example/api/clusters/clusterID/control-plane"

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/clusters/clusterID/control-plane';
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/clusters/clusterID/control-plane"

	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/clusters/clusterID/control-plane")

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

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

```csharp
using RestSharp;

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