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

# Get overview

GET /v1/overview

Get overview of the system

Reference: https://docs.nvidia.com/fleet-intel/fleet-intel/api-explorer/overview/get-v-1-overview

## OpenAPI Specification

```yaml
openapi: 3.1.0
info:
  title: fleet-intelligence
  version: 1.0.0
paths:
  /v1/overview:
    get:
      operationId: getV1Overview
      summary: Get overview
      description: Get overview of the system
      tags:
        - overview
      parameters:
        - name: includeMetrics
          in: query
          description: >-
            Include metrics in response (default: true). Set to false for better
            performance when metrics are not needed.
          required: false
          schema:
            type: boolean
            default: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/models.OverviewResponse'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/models.ErrorResponse'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/models.ErrorResponse'
        '403':
          description: Forbidden - UAM authorization denied
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/models.ErrorResponse'
        '499':
          description: Client Closed Request - request was canceled by the client
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/models.ErrorResponse'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/models.ErrorResponse'
        '503':
          description: Service Unavailable
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/models.ErrorResponse'
components:
  schemas:
    models.Aggregation:
      type: string
      enum:
        - average
        - sum
        - min
        - max
        - none
      title: models.Aggregation
    models.Metric:
      type: object
      properties:
        aggregation:
          $ref: '#/components/schemas/models.Aggregation'
        description:
          type: string
        lastUpdated:
          type: string
        name:
          type: string
        unit:
          type: string
        value:
          type: number
          format: double
      title: models.Metric
    models.OverviewResponse:
      type: object
      properties:
        computeZoneCount:
          type: integer
        cpuCoresCount:
          type: integer
        degradedNodeCount:
          type: integer
        gpusCount:
          type: integer
        healthNodeCount:
          type: integer
        healthPercentage:
          type: number
          format: double
        metrics:
          type: array
          items:
            $ref: '#/components/schemas/models.Metric'
        nodeGroupCount:
          type: integer
        nodesCount:
          type: integer
        unhealthyNodeCount:
          type: integer
        unknownNodeCount:
          type: integer
      title: models.OverviewResponse
    models.KASRequestStatus:
      type: object
      properties:
        requestId:
          type: string
          description: Request ID for tracing
        statusCode:
          type: string
          description: Status code from KAS
        statusDescription:
          type: string
          description: Status description from KAS
      description: >-
        RequestStatus contains KAS-specific error details

        This is added to reflect the field in OpenAPI docs for UI reference and
        not populated by our code

        If KAS returns an error, the request will not be forwarded to the
        backend
      title: models.KASRequestStatus
    models.ErrorResponse:
      type: object
      properties:
        details:
          type: string
          description: Detailed error information
        error:
          type: string
          description: Error message or type
        requestStatus:
          $ref: '#/components/schemas/models.KASRequestStatus'
      description: >-
        Standard error response returned by all API endpoints. For KAS API
        errors, requestStatus fields are populated.
      title: models.ErrorResponse

```

## Examples



**Response**

```json
{
  "computeZoneCount": 5,
  "cpuCoresCount": 5,
  "degradedNodeCount": 5,
  "gpusCount": 5,
  "healthNodeCount": 5,
  "healthPercentage": 50,
  "metrics": [
    {
      "aggregation": "average",
      "description": "System memory metrics",
      "lastUpdated": "2024-01-15T14:30:00Z",
      "name": "memory",
      "unit": "percent",
      "value": 72.3
    }
  ],
  "nodeGroupCount": 5,
  "nodesCount": 5,
  "unhealthyNodeCount": 5,
  "unknownNodeCount": 5
}
```

**SDK Code**

```python
import requests

url = "https://api.example.com/v1/overview"

response = requests.get(url)

print(response.json())
```

```javascript
const url = 'https://api.example.com/v1/overview';
const options = {method: 'GET'};

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 := "https://api.example.com/v1/overview"

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

	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://api.example.com/v1/overview")

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

request = Net::HTTP::Get.new(url)

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://api.example.com/v1/overview")
  .asString();
```

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

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://api.example.com/v1/overview');

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

```csharp
using RestSharp;

var client = new RestClient("https://api.example.com/v1/overview");
var request = new RestRequest(Method.GET);
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let request = NSMutableURLRequest(url: NSURL(string: "https://api.example.com/v1/overview")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"

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