> ## Documentation Index
> Fetch the complete documentation index at: https://altostrat.io/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# List dashboards

> Lists available Grafana dashboards with their variables and panel metadata.



## OpenAPI

````yaml /api/en/monitoring-metrics.yaml get /metrics/dashboards
openapi: 3.0.3
info:
  title: Altostrat Monitoring & Metrics API
  version: 1.0.0
  description: >-
    Retrieve portal-facing metrics through the public `/metrics` gateway path,
    including dashboards, WAN tunnels, interfaces, ARP entries, syslogs, BGP,
    and DNS reports.
servers:
  - url: https://v1.api.altostrat.io
security:
  - bearerAuth: []
tags:
  - name: Dashboard
    description: High-level, aggregated metrics for network performance and data usage.
  - name: WAN Tunnels & Performance
    description: >-
      Endpoints for managing and retrieving performance data from SD-WAN
      tunnels.
  - name: Site Interfaces & Metrics
    description: >-
      Endpoints for listing network interfaces at a site and fetching their
      traffic metrics.
  - name: Device Health & Status
    description: Endpoints for monitoring the health and status of network devices.
  - name: ARP Inventory
    description: >-
      Endpoints for querying and managing the Address Resolution Protocol (ARP)
      table to discover devices on the network.
  - name: Network Logs
    description: Access to system, DNS, and BGP logs for diagnostics and security analysis.
  - name: Grafana Dashboards
    description: List Grafana dashboards, query dashboard panels, and export panel data.
  - name: Prometheus Querying
    description: >-
      Discover available metrics and labels, then execute Prometheus queries
      scoped to your workspace.
paths:
  /metrics/dashboards:
    get:
      tags:
        - Grafana Dashboards
      summary: List dashboards
      description: >-
        Lists available Grafana dashboards with their variables and panel
        metadata.
      operationId: listGrafanaDashboards
      responses:
        '200':
          description: Dashboards available to the authenticated workspace.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DashboardListResponse'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '500':
          $ref: '#/components/responses/ServerError'
components:
  schemas:
    DashboardListResponse:
      type: object
      properties:
        dashboards:
          type: array
          items:
            $ref: '#/components/schemas/DashboardSummary'
    DashboardSummary:
      type: object
      properties:
        uid:
          type: string
          nullable: true
          example: router_system_metrics
        slug:
          type: string
          example: router-system-metrics
        title:
          type: string
          example: Router system metrics
        url:
          type: string
          nullable: true
        tags:
          type: array
          items:
            type: string
        folder_title:
          type: string
          nullable: true
          example: SDX
        query_url:
          type: string
          example: /metrics/dashboards/router_system_metrics/query
        variables:
          type: array
          items:
            $ref: '#/components/schemas/DashboardVariable'
        panels:
          type: array
          items:
            $ref: '#/components/schemas/DashboardPanel'
    ErrorResponse:
      type: object
      properties:
        type:
          type: string
          description: A broad category for the error (e.g., 'invalid_request_error').
          example: invalid_request_error
        code:
          type: string
          description: A short, unique string identifying the specific error.
          example: parameter_invalid
        message:
          type: string
          description: A human-readable description of what went wrong.
          example: The provided 'siteId' is not a valid UUID.
        doc_url:
          type: string
          description: >-
            A direct link to the documentation page for this specific error
            code.
          example: https://docs.altostrat.io/errors/parameter_invalid
    DashboardVariable:
      type: object
      properties:
        name:
          type: string
          example: Site
        label:
          type: string
          example: Site
        type:
          type: string
          example: query
        query:
          type: string
          nullable: true
        multi:
          type: boolean
          example: false
        includeAll:
          type: boolean
          example: false
        allValue:
          nullable: true
        current:
          nullable: true
    DashboardPanel:
      type: object
      properties:
        id:
          type: integer
          nullable: true
          example: 12
        title:
          type: string
          example: CPU load
        type:
          type: string
          example: timeseries
        gridPos:
          type: object
          nullable: true
          additionalProperties: true
  responses:
    Unauthorized:
      description: Unauthorized - The request lacks valid authentication credentials.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    ServerError:
      description: Internal Server Error - An unexpected error occurred on the server.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT

````