dashboards

Archive a dashboard (org admin only).

Hides the dashboard from the directory, search, Home and the stale queue, and stops its scheduled exports and email reports (they resume, with at most one catch-up tick, on unarchive). Archive reuses the soft-delete gate (deleted_at), so the dashboard, its pages and its revision history are kept intact. Requires share:manage. Audit-logged as dashboard.archive. Reverse with POST /v1/dashboards/{id}/unarchive.

post/v1/dashboards/{id}/archive

Request

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

Response

Archived.

Changes

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