SOsolarwinds
dashboards

Update a dashboard

Changed on

Partial update of a dashboard. Scalar fields (description, categoryId, isPrivate) are merged — omitting them preserves the existing value. The widgets and layout arrays are fully replaced; any widget absent from the layout is deleted.

patch/v1/dashboards/{dashboardId}

Request

Path parameters

dashboardIdstring required

Dashboard identifier.

Request body

versioninteger

Schema version of the dashboard definition. Matches the version field returned in Dashboard responses. When the response returns null, send 1.

namestring

Dashboard display name.

descriptionstring

Dashboard description. If omitted, the existing value is preserved.

isPrivateboolean

Whether the dashboard is private to the owning user. If omitted, the existing value is preserved.

categoryIdstring

Category to assign to this dashboard. If omitted, the existing value is preserved.

validationVersioninteger

Validation rules version. Defaults to the current version on the server when omitted.

enableValidationboolean

When true, enables widget validation. Validation is skipped by default.

Example request

{
  "name": "APM Usage",
  "description": "Displays metric widgets of APM data usage."
}

Response

The updated dashboard.

idstring required

Dashboard identifier.

versioninteger nullable required

Schema version of the dashboard definition. Null implies version 1.

namestring required

Dashboard display name.

descriptionstring nullable required

Dashboard description.

systemReferencestring nullable required

Stable reference key for system dashboards; null for user-created dashboards.

isPrivateboolean required

Whether the dashboard is private to the owning user.

ownerIdstring nullable required

Identifier of the user who owns this dashboard.

createdAtstring date-time required

Timestamp when the dashboard was created.

updatedAtstring date-time required

Timestamp when the dashboard was last updated.

isFavoriteboolean required

Whether the current user has marked this dashboard as a favorite.

Example response

{
  "id": "68564",
  "name": "APM Usage",
  "description": "Displays metric widgets of APM data usage.",
  "category": {
    "id": "4",
    "name": "APM",
    "createdAt": "2022-12-22T11:21:50.000Z",
    "updatedAt": "2022-12-22T11:21:50.000Z"
  },
  "systemReference": "apm-usage",
  "createdAt": "2022-12-22T11:21:50.000Z",
  "updatedAt": "2022-12-22T11:21:50.000Z",
  "report": {
    "id": "105",
    "title": "test"
  }
}

Changes