Skip to main content
POST
List dashboards

Restrictions

Usage

  • Only dashboards stored directly in folder_id are returned; dashboards in its subfolders are not included. Use POST /monit/dashboard/search to look across folders.
  • folder_id must be an existing folder of the account; reading is open to every member, whatever team the folder belongs to, so only an unknown folder fails, with FolderNotFound (HTTP 404). Trashed dashboards are never listed.
  • query is split on whitespace; a dashboard matches when every word appears as a substring of its title or description.
  • Sort keys are title and updated_at, at most two and each used once; the default is updated_at descending, and ties are ordered by dashboard_id.

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

List the dashboards in one folder. Unlike search, folder_id is required.

folder_id
integer<uint64>
required

Folder whose directly contained dashboards are listed; subfolders are not included.

Required range: x >= 1
query
string

Optional search words separated by whitespace, at most 128 Unicode code points. A dashboard matches when every word appears in its title or description.

Maximum string length: 128
sort
object[]

Sort keys; defaults to updated_at descending.

Maximum array length: 2
p
integer

Page number, 1-based. Defaults to 1.

Required range: x >= 1
limit
integer

Page size, 1–100. Defaults to 20.

Required range: 1 <= x <= 100

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 page of dashboards plus the total matching count.