Skip to main content
ZStack
Monitoring & Collection/Grafana Dashboards

ListDashboards

List dashboards for a tenant with optional category and search filters

GET/api/v1/monitoring/dashboards

Operation ID

ListDashboards

Since

1.0.0

Execution Mode

Synchronous

Auth Context

Auth Required

Auth Context

Send these values as request headers when calling this API.

AuthorizationstringRequired

Bearer Token

X-Tenant-IDstring

X-Tenant-ID

Request Inputs

Query Parameters

  • tenantId
    String

    Filter by tenant UUID Filter by tenant UUID

  • category
    String

    Filter by category Filter by category

  • search
    String

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

  • page
    Integer

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

    Example: 0

  • size
    Integer

    Page size for pagination Page size for pagination

    Example: 0

Responses

200 OK
200 OK

On success, this API returns the following response structure.

  • items
    List

    Collection of result items

    Example: (nested array)

    • id
      String

      Unique identifier of the dashboard

      Example: dash-001-abc

    • tenantId
      String

      UUID of the tenant owning this dashboard

      Example: tenant-001-xyz

    • title
      String

      Display title of the dashboard

      Example: VM Performance Overview

    • category
      String

      Category the dashboard belongs to

      Example: compute

    • layout
      List

      Layout for this resource

      Example: (nested array)

      • panelId
        String

        Unique identifier of the panel within the dashboard

        Example: panel-cpu-001

      • x
        Integer

        Horizontal grid position of the panel

        Example: 20

      • y
        Integer

        Vertical grid position of the panel

        Example: 20

      • w
        Integer

        Width of the panel in grid units

        Example: 12

      • h
        Integer

        Height of the panel in grid units

        Example: 8

    • createdBy
      String

      User ID of the dashboard creator

      Example: user-001-abc

    • createdAt
      String

      Created at

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

    • updatedAt
      String

      Updated at

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

    • deletedAt
      String

      Deleted at

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

    • version
      Integer

      Current version number of this dashboard

      Example: 3

  • total
    Integer

    Total number of dashboards matching the filter

    Example: 8

  • limit
    Integer

    Page size limit

    Example: 20

  • offset
    Integer

    Pagination offset

    Example: 20