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

UpdateDashboard

Update an existing dashboard's title or panel layout

Execution Availability

Try It Out

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

Path Parameters

Request Inputs

Path Parameters

  • idStringRequired

    UUID of the dashboard to update

Body Fields

  • tenantIdStringRequired

    UUID of the tenant owning the dashboard

    Example: tenant-001-xyz

  • userIdStringRequired

    UUID of the user performing the update

    Example: user-001-abc

  • titleStringRequired

    Updated display title

    Example: VM Performance Overview v2

  • layoutListRequired

    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

Responses

200 OK

On success, this API returns the following response structure.

  • 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

Endpoint

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

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

Operation ID

UpdateDashboard

Permalink

Request Example

curl -X PUT '{host}/api/v1/monitoring/dashboards/{id}' -H 'Authorization: Bearer {token}' -H 'Content-Type: application/json' -d '{"tenantId":"tenant-001-xyz","userId":"user-001-abc","title":"VM Performance Overview v2","layout":"(nested array)"}'

Response Example

200
{
  "id": "dash-001-abc",
  "tenantId": "tenant-001-xyz",
  "title": "VM Performance Overview",
  "category": "compute",
  "layout": [
    {}
  ],
  "createdBy": "user-001-abc",
  "createdAt": "example",
  "updatedAt": "example"
}

Change History

This API has no change history records yet.

View all change history