Skip to main content
POST
Restore dashboard

Restrictions

Usage

  • Only dashboards in the trash can be restored; any other dashboard returns DashboardNotFound (HTTP 404).
  • expected_revision must equal the trashed dashboard’s current revision (the revision returned by delete and shown in the trash listing), otherwise DashboardRevisionConflict (HTTP 409).
  • Omit folder_id to restore into the original folder. If that folder no longer exists, the account owner and admins get RestoreFolderRequired (HTTP 409) and must pass a destination; other members can only restore dashboards whose original folder they can still access and get DashboardNotFound otherwise.
  • A missing or inaccessible destination folder returns FolderNotFound (HTTP 404). Restoring increments revision.
  • Audit-logged.

Authorizations

app_key
string
query
required

APP Key created in the Flashduty console under My → APP Key. Send it as the app_key query parameter or in the Fd-App-Key request header. Its effective access is the intersection of the key's permission scope and the creator's current role permissions. Keep it secret.

Body

application/json

Restore a trashed dashboard, optionally into a different folder.

dashboard_id
string
required

Canonical UUIDv7 of the dashboard.

Pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-7[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$
expected_revision
integer<uint64>
required

Current revision of the trashed dashboard, as returned by the delete call or listed in the trash. The restore fails with DashboardRevisionConflict if it does not match.

Required range: x >= 1
folder_id
integer<uint64> | null

Destination folder. Omit or send null to restore into the original folder; if that folder no longer exists the call fails with RestoreFolderRequired and a destination must be passed.

Required range: x >= 1

Response

Success

Success response envelope. On every 2xx response, request_id identifies the call (also mirrored in the Flashcat-Request-Id header) and data holds the endpoint-specific payload. Failure responses use a different shape — see ErrorResponse.

request_id
string
required

Unique ID for this request. Mirrored in the Flashcat-Request-Id response header. Include it when reporting issues.

Example:

"01HK8XQE3Z7JM2NTFQ5YJ8P9R4"

data
object

A stored dashboard: its identity, revision counter, placement and full definition. revision increments on every accepted write and must be echoed back as expected_revision for the next mutation.