Skip to main content
POST
Create dashboard

Restrictions

Usage

  • The caller generates dashboard_id (a lowercase canonical UUIDv7). Retrying after a timeout with the same ID fails with DashboardIDConflict (HTTP 409) instead of creating a second dashboard.
  • folder_id must be one of the folders the app_key owner can access: folders they created or that belong to one of their teams, plus all subfolders of those; the account owner and admins can access every folder; otherwise the call fails with FolderNotFound (HTTP 404).
  • A new dashboard starts at revision 1; send it as expected_revision on the next update, move or delete.
  • An invalid definition returns InvalidParameter (HTTP 400) whose message lists each violation as <JSON pointer>: <reason>. A definition over 1 MiB or over a count limit such as sections per tab, panels, queries or variables, or a request body over 2 MiB, returns EntityTooLarge (HTTP 413); a schema_version other than dashboard.v1 returns UnsupportedSchemaVersion (HTTP 422).
  • 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

Create a dashboard. The caller supplies the ID, so a retry after a timeout returns DashboardIDConflict rather than silently creating a second dashboard.

dashboard_id
string
required

Lowercase canonical UUIDv7 generated by the caller; it becomes the dashboard's permanent ID.

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
folder_id
integer<uint64>
required

Folder to create the dashboard in; must exist and be accessible to the app_key owner, otherwise FolderNotFound.

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.

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.