Skip to main content
POST
Update dashboard

Restrictions

Usage

  • Send the whole definition; anything left out is removed, not kept from the stored version.
  • expected_revision must equal the stored revision, otherwise the call fails with DashboardRevisionConflict (HTTP 409); re-read the dashboard and retry.
  • On success revision goes up by 1 and a revision entry carrying message is recorded. When the normalized definition and schema_version equal the stored ones, changed is false, revision stays the same and no revision entry is recorded.
  • Titles and descriptions are trimmed and an omitted numeric unit is stored as unitless, so the returned definition can differ slightly from the request.
  • A dashboard in the trash returns DashboardDeleted (HTTP 410); a dashboard whose folder the caller cannot access returns AccessDenied. Validation and size errors are the same as for POST /monit/dashboard/create.
  • 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

Replace a dashboard's definition. The whole definition is sent, not a patch; expected_revision makes the write compare-and-swap.

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}$
schema_version
enum<string>
required

Wire schema version; only dashboard.v1 is accepted.

Available options:
dashboard.v1
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
definition
object
required

Complete dashboard payload stored as a portable dashboard.v1 document. Unknown keys, duplicate keys, trailing values and nesting deeper than 32 levels are rejected, and the serialized form must stay within 1 MiB. Limits: 10 tabs, 10 sections per tab, 30 panels and 100 queries per tab, 100 panels and 300 queries per dashboard, 20 variables.

message
string

Optional revision message, at most 1024 Unicode code points. Stored with the revision and never returned by this endpoint.

Maximum string length: 1024

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 an update or move. changed is false when nothing was written — for update, the normalized definition and schema_version equal the stored ones; for move, the dashboard is already in the target folder. revision then stays the same and resource describes the unchanged dashboard.