Skip to main content
POST
Delete dashboard

Restrictions

Usage

  • The delete is soft: the dashboard moves to the trash and is permanently removed, with all its revisions, 30 days after deletion. Restore it before then with POST /monit/dashboard/restore.
  • Deleting increments revision; the returned revision is the value to send as expected_revision when restoring.
  • expected_revision must equal the stored revision, otherwise DashboardRevisionConflict (HTTP 409); deleting a dashboard that is already in the trash returns DashboardDeleted (HTTP 410).
  • 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

Move a dashboard to the trash. It is purged permanently 30 days after deletion; until then the restore endpoint can undo the delete.

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

Revision the caller last read. The write fails with DashboardRevisionConflict unless it still matches the stored revision.

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

Result of moving a dashboard to the trash.