Skip to main content
POST
List dashboards

Restrictions

Usage

  • The definition is not returned; call POST /rum/dashboard/get for one dashboard.
  • query matches the title or description; every space-separated word must match. Deleted dashboards are listed by POST /rum/dashboard/trash/list instead.

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 request. p is 1-based and limit defaults to 20, newest first.

query
string

Search text, at most 128 characters. Split on spaces; each word must appear in the title or the description.

sort
object[]

Sort order, at most two unique fields; defaults to updated_at descending.

Maximum array length: 2
p
integer
default:1

Page number, 1-based. Defaults to 1.

Required range: x >= 1
limit
integer
default:20

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

One page of dashboards.