> 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 available metrics

GET /v1/metrics

Get a list of all available metrics, organized by component. Supports optional filtering by isCritical, aggregatable, and type. Unknown or false values for boolean params are treated as no filter.
Use psirtComponent=true to include active PSIRT CVE sub-components under the "psirt" component.

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

## OpenAPI Specification

```yaml
openapi: 3.1.0
info:
  title: fleet-intelligence
  version: 1.0.0
paths:
  /v1/metrics:
    get:
      operationId: getV1Metrics
      summary: Get available metrics
      description: >-
        Get a list of all available metrics, organized by component. Supports
        optional filtering by isCritical, aggregatable, and type. Unknown or
        false values for boolean params are treated as no filter.

        Use psirtComponent=true to include active PSIRT CVE sub-components under
        the "psirt" component.
      tags:
        - metrics
      parameters:
        - name: isCritical
          in: query
          description: >-
            If 'true', only critical metrics are returned. If absent or 'false',
            all metrics are returned.
          required: false
          schema:
            type: string
        - name: aggregatable
          in: query
          description: >-
            If 'true', metrics that cannot be aggregated across nodes are
            excluded. If absent or 'false', all metrics are returned.
          required: false
          schema:
            type: string
        - name: type
          in: query
          description: >-
            If set, only metrics matching this type are returned (e.g.,
            'utilization', 'limit'). If absent, all metrics are returned.
          required: false
          schema:
            type: string
        - name: psirtComponent
          in: query
          description: 'Include active PSIRT CVE sub-components (default: false)'
          required: false
          schema:
            type: boolean
        - name: entityLevel
          in: query
          description: >-
            Optional entity scope for architecture-aware filtering. Currently
            only 'node' is supported.
          required: false
          schema:
            $ref: '#/components/schemas/V1MetricsGetParametersEntityLevel'
        - name: entityID
          in: query
          description: >-
            Entity ID for architecture-aware filtering. Required when
            entityLevel is set.
          required: false
          schema:
            type: string
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/models.GetMetricsResponse'
        '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'
components:
  schemas:
    V1MetricsGetParametersEntityLevel:
      type: string
      enum:
        - node
      title: V1MetricsGetParametersEntityLevel
    models.MetricInfo:
      type: object
      properties:
        displayName:
          type: string
        name:
          type: string
        type:
          type: string
        unit:
          type: string
      title: models.MetricInfo
    models.ComponentMetricList:
      type: object
      properties:
        displayName:
          type: string
        isBackendComponent:
          type: boolean
        metrics:
          type: array
          items:
            $ref: '#/components/schemas/models.MetricInfo'
        name:
          type: string
        subComponents:
          type: array
          items:
            type: string
          description: Dynamic children (e.g., active PSIRT CVEs)
      title: models.ComponentMetricList
    models.GetMetricsResponse:
      type: object
      properties:
        components:
          type: array
          items:
            $ref: '#/components/schemas/models.ComponentMetricList'
      title: models.GetMetricsResponse
    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
{
  "components": [
    {
      "displayName": "string",
      "isBackendComponent": true,
      "metrics": [
        {
          "displayName": "string",
          "name": "string",
          "type": "string",
          "unit": "string"
        }
      ],
      "name": "string",
      "subComponents": [
        "string"
      ]
    }
  ]
}
```

**SDK Code**

```python
import requests

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

response = requests.get(url)

print(response.json())
```

```javascript
const url = 'https://api.example.com/v1/metrics';
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/metrics"

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

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/metrics")
  .asString();
```

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

$client = new \GuzzleHttp\Client();

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

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

```csharp
using RestSharp;

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