API: Recovery
Preview and restore recently deleted dashboards and reports, with public access and automation kept disabled. All endpoints require authentication unless noted. 6 endpoints.
GET /api/recovery/items
Section titled “GET /api/recovery/items”List recently deleted dashboards and reports
Query parameters
| Name | Type | Required | Description |
|---|---|---|---|
type |
"all" | "dashboard" | "report" |
no | |
status |
"all" | "restorable" | "expired" |
no | |
search |
string | no | |
limit |
integer | no | |
offset |
integer | no |
Responses: 200 · 400 · 401 · 404
GET /api/recovery/items/{type}/{id}/preview
Section titled “GET /api/recovery/items/{type}/{id}/preview”Preview exactly what a recovery will restore and keep disabled
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
type |
"dashboard" | "report" |
yes | |
id |
string | yes |
Responses: 200 · 400 · 401 · 404
POST /api/recovery/items/{type}/{id}/restore
Section titled “POST /api/recovery/items/{type}/{id}/restore”Restore a deleted item with public access and automation disabled
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
type |
"dashboard" | "report" |
yes | |
id |
string | yes |
Responses: 200 · 400 · 401 · 404
GET /api/recovery/policy
Section titled “GET /api/recovery/policy”Get the workspace recovery eligibility policy
Responses: 200 · 400 · 401 · 404
PUT /api/recovery/policy
Section titled “PUT /api/recovery/policy”Update the workspace recovery eligibility window
Request body (JSON)
| Field | Type | Required | Description |
|---|---|---|---|
retentionDays |
integer | yes |
Responses: 200 · 400 · 401 · 404
GET /api/recovery/receipts
Section titled “GET /api/recovery/receipts”List transactional recovery receipts for the workspace
Query parameters
| Name | Type | Required | Description |
|---|---|---|---|
limit |
integer | no | |
offset |
integer | no |
Responses: 200 · 400 · 401 · 404