Skip to main content
ZStack
Monitoring & Collection/Grafana Dashboards

UpdateDashboard

Update an existing dashboard's title or panel layout

PUT/api/v1/monitoring/dashboards/{id}

Operation ID

UpdateDashboard

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

application/json

Path Parameters

  • id
    StringRequired

    UUID of the dashboard to update

Body Fields

  • tenantId
    StringRequired

    UUID of the tenant owning the dashboard

    Example: tenant-001-xyz

  • userId
    StringRequired

    UUID of the user performing the update

    Example: user-001-abc

  • title
    StringRequired

    Updated display title

    Example: VM Performance Overview v2

  • layout
    ListRequired

    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

Responses

200 OK
200 OK

On success, this API returns the following response structure.

  • 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