> This page is for Self-Hosted, version v3.0 (default).
> For other versions, use one of these documentation indexes:
> - v3.0 (default): https://docs.nvidia.com/run-ai/self-hosted/v3.0/llms.txt
> - v2.26: https://docs.nvidia.com/run-ai/self-hosted/v2.26/llms.txt
> - v2.25: https://docs.nvidia.com/run-ai/self-hosted/v2.25/llms.txt
> - v2.24: https://docs.nvidia.com/run-ai/self-hosted/v2.24/llms.txt

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

# Get clusters minimal data

GET http://localhost:8080/api/v1/clusters/minimal

Retrieve essential cluster data required for common operations (e.g., workload submission)

Reference: https://docs.nvidia.com/run-ai/self-hosted/reference/rest-api/endpoints/organizations/clusters/get-clusters-minimal-data

## Authentication

- `Authorization` header (bearer token, required) — Bearer authentication

## Request

### Query parameters

- `filterBy` (list of string, optional) — Filter clusters by a parameter. Use the format field-name operator value. Operators are == Equals, != Not equals, \<= Less than or equal, >= Greater than or equal. Dates are in ISO 8601 timestamp format and available for operators ==, !=, \<= and >=.
- `offset` (integer, optional) — The offset of the first item returned in the collection.
- `limit` (integer, optional, default: 50) — The maximum number of entries to return.

## Response

### 200

ok

- `clusters` (list of ClustersMinimalData, optional)

## Errors

### 400 Bad Request Error

Bad request.

- `code` (integer, required)
- `message` (string, required)
- `details` (string, optional)

### 503 Service Unavailable Error

unexpected error

- `code` (integer, required)
- `message` (string, required)
- `details` (string, optional)

## Types

### ClustersMinimalData

- `uuid` (string, required)
- `name` (string, required)
- `tenantId` (integer, required) — The id of the tenant.
- `version` (string, optional, nullable)
- `domain` (string, optional, nullable)
- `platform` (ClusterReportedStatusPlatform, optional)
- `state` (enum, optional) — The cluster's state.
  - Allowed values: `WaitingToConnect`, `Connected`, `Disconnected`, `MissingPrerequisites`, `ServiceIssues`, `Unknown`
- `ingressClass` (string, optional, nullable) — the ingress class that is configured for the cluster
- `dependenciesStatus` (ClusterDependenciesStatus, optional)

### ClusterReportedStatusPlatform

- `type` (enum, optional, nullable) — the cluster platform type
  - Allowed values: `vanilla`, `openshift`, `rke`, `gke`, `aks`, `eks`
- `kubeVersion` (string, optional, nullable) — the cluster kubernetes version

### ClusterDependenciesStatus

- `required` (map from string to ClusterDependencyStatus, required)
- `optional` (map from string to ClusterDependencyStatus, required)

### ClusterDependencyStatus

- `available` (boolean, required) — whether the dependency is available
- `reason` (string, optional) — the reason for the dependency status
- `components` (map from string to ClusterDependencyStatus, optional)

## Examples

**Response**

```json
{
  "clusters": [
    {
      "uuid": "string",
      "name": "string",
      "tenantId": 1001,
      "version": "string",
      "domain": "string",
      "platform": {
        "type": "vanilla",
        "kubeVersion": "string"
      },
      "state": "WaitingToConnect",
      "ingressClass": "nginx",
      "dependenciesStatus": {
        "required": {},
        "optional": {}
      }
    }
  ]
}
```

**SDK Code**

```python
import requests

url = "http://localhost:8080/api/v1/clusters/minimal"

headers = {"Authorization": "Bearer <token>"}

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

print(response.json())
```

```javascript
const url = 'http://localhost:8080/api/v1/clusters/minimal';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

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"
	"net/http"
	"io"
)

func main() {

	url := "http://localhost:8080/api/v1/clusters/minimal"

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

	req.Header.Add("Authorization", "Bearer <token>")

	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("http://localhost:8080/api/v1/clusters/minimal")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

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("http://localhost:8080/api/v1/clusters/minimal")
  .header("Authorization", "Bearer <token>")
  .asString();
```

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

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'http://localhost:8080/api/v1/clusters/minimal', [
  'headers' => [
    'Authorization' => 'Bearer <token>',
  ],
]);

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

```csharp
using RestSharp;

var client = new RestClient("http://localhost:8080/api/v1/clusters/minimal");
var request = new RestRequest(Method.GET);
request.AddHeader("Authorization", "Bearer <token>");
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = ["Authorization": "Bearer <token>"]

let request = NSMutableURLRequest(url: NSURL(string: "http://localhost:8080/api/v1/clusters/minimal")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"
request.allHTTPHeaderFields = headers

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()
```