Skip to main content
POST
Get dashboard detail

Restrictions

Usage

  • Reading is open to every member of the account, so dashboards in every folder are visible whichever team the folder belongs to. An unknown dashboard ID, or one from another account, returns DashboardNotFound (HTTP 404).
  • A dashboard in the trash returns DashboardDeleted (HTTP 410) instead of its definition; find it with POST /monit/dashboard/trash/list and bring it back with POST /monit/dashboard/restore.
  • Send the returned revision as expected_revision on the next update, move or delete.

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

Identifies a single dashboard.

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}$

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.