Skip to main content
POST
List monitor folders

Restrictions

Usage

  • The response is a flat list of the folders in the requested scope, not a tree: rebuild the hierarchy from parent_id and parent_path, and search client-side. An account with no visible folder gets [].
  • scope picks the set. When scope is omitted, account owners, admins and roles with the all-teams view scope get all, and other members get mine. mine is the folders your teams own and the folders you created, everything below them, and the ancestor folders needed to reach them; all is every folder of the account. The scope only filters the view — it no longer limits what you may read.
  • writable carries the folder grant alone (team member, folder creator, account owner or admin); the APP Key’s role permissions are checked separately, so combine both before offering an edit action.
  • Dashboards and alert rules both live in this folder tree, so the same IDs appear as folder_id on dashboard payloads and alert rules.

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

Optional read scope for folder-based listings. An empty request body is the same as omitting scope.

scope
enum<string>

Which folders the response covers. mine covers the folders of the caller's teams and the folders the caller created, plus their descendants; all covers every folder of the account. When omitted, it is all for account owners, admins and roles with the all-teams view scope, and mine for other members. Any other value fails with InvalidParameter.

Available options:
mine,
all

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[]

Operation-specific payload, documented in each operation's 200 response. Operations without a payload return {} or omit data entirely.