Skip to main content
POST
Update dashboard

Authorizations

app_key
string
query
required

App key issued from the Flashduty console under Account → APP Keys. Required on every public API call. Keep it secret — it grants the same access as the owning account.

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, NaN/Inf, over-range numbers and trailing values are rejected; the serialized form must stay within 1 MiB.

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
required

Result of an update or move. changed is false when the write was a no-op — the canonical serialized definition matched the stored one byte for byte, in which case resource still describes the unchanged dashboard.