dashboards

Restore a page to a prior version.

Reverts the page's arrangement (layout) and metadata to the chosen revision. Restore is a forward edit — a new revision is written and the page's version increments — so history stays append-only. The promoted element coordinates are re-synced from the restored layout; element content (panel JSON) is untouched, as element histories are independent. A new dashboard revision is written so GET /v1/dashboards/{id} stays consistent.

post/v1/dashboards/{id}/pages/{pageId}/restore

Request

  • Base URL: http://localhost:8080
  • URL: http://localhost:8080/v1/dashboards/{id}/pages/{pageId}/restore
  • Auth: one of:
    • API key in cookie dvt_session
    • HTTP bearer

Query parameters

reasonstring

Optional change note (the "why") recorded in version history; 1–280 characters. The body's reason is the primary carrier (RestoreRequest); this query parameter (or the X-Dvt-Change-Reason header) is the fallback used when the body omits it. Over-cap values return 400.

Request body

versioninteger required

The prior version to restore (from GET .../revisions).

reasonstring

Optional provenance note (the "why") recorded on the new revision the restore writes (DVT-1658). Max 280 characters.

Response

Page restored; returns the new page header.

Changes

No recorded changes to this operation across all 1 revision of this API.