Skip to main content
API Explorer|API Explorer
Monitoring & Collection/Grafana Dashboards
GETGrafanaSince 1.0SynchronousAuth Required

ListDashboards

List dashboards for a tenant with optional category and search filters

Execution Availability

Try It Out

Submit a mock request using the current auth context and example-driven inputs.

Query Parameters

Request Inputs

Query Parameters

  • tenantIdString

    Filter by tenant UUID Filter by tenant UUID

  • categoryString

    Filter by category Filter by category

  • searchString

    Search term to filter dashboards by title Search term to filter dashboards by title

  • pageInteger

    Page number for pagination (1-based) Page number for pagination (1-based)

    Example: 0

  • sizeInteger

    Page size for pagination Page size for pagination

    Example: 0

Responses

200 OK

On success, this API returns the following response structure.

  • itemsList

    Collection of result items

    Example: (nested array)

    • idString

      Unique identifier of the dashboard

      Example: dash-001-abc

    • tenantIdString

      UUID of the tenant owning this dashboard

      Example: tenant-001-xyz

    • titleString

      Display title of the dashboard

      Example: VM Performance Overview

    • categoryString

      Category the dashboard belongs to

      Example: compute

    • layoutList

      Layout for this resource

      Example: (nested array)

      • panelIdString

        Unique identifier of the panel within the dashboard

        Example: panel-cpu-001

      • xInteger

        Horizontal grid position of the panel

        Example: 20

      • yInteger

        Vertical grid position of the panel

        Example: 20

      • wInteger

        Width of the panel in grid units

        Example: 12

      • hInteger

        Height of the panel in grid units

        Example: 8

    • createdByString

      User ID of the dashboard creator

      Example: user-001-abc

    • createdAtString

      Created at

      Example: 2026-01-15T08:00:00Z

    • updatedAtString

      Updated at

      Example: 2026-01-15T08:00:00Z

    • deletedAtString

      Deleted at

      Example: 2026-01-15T08:00:00Z

    • versionInteger

      Current version number of this dashboard

      Example: 3

  • totalInteger

    Total number of dashboards matching the filter

    Example: 8

  • limitInteger

    Page size limit

    Example: 20

  • offsetInteger

    Pagination offset

    Example: 20

Endpoint

GET/api/v1/monitoring/dashboards

/api/v1/monitoring/dashboards

Operation ID

ListDashboards

Permalink

Request Example

curl -X GET '{host}/api/v1/monitoring/dashboards' -H 'Authorization: Bearer {token}'

Response Example

200
{
  "items": [
    {}
  ],
  "total": 8,
  "limit": 20,
  "offset": 20
}

Change History

This API has no change history records yet.

View all change history