dashboards

Delete an element.

Soft-deletes the element and removes it from the page's layout (versioning the page). The element's revision history is retained; its slug becomes reusable. The element's current version travels via the version query parameter or If-Match header. Refused on legacy dashboards (409 legacy-dashboard). Editor or above.

Provenance (DVT-1792): pass a required reason query parameter (or the X-Dvt-Change-Reason header) explaining why the element is being removed — it is propagated into the dashboard revision's change summary so the Versions tab shows why.

delete/v1/dashboards/{id}/pages/{pageId}/elements/{elementId}

Request

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

Query parameters

versioninteger

The element's current version (or use If-Match).

reasonstring required

Required provenance note (the "why") for the deletion, propagated into the dashboard revision's change summary (DVT-1792). 1–280 characters; an empty or over-long value is rejected with 400. May also be supplied via the X-Dvt-Change-Reason header.

Response

Deleted.

Changes

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