Skip to main content
POST

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

Datasource ID from /monit/datasource/list.

Required range: x >= 1
tool
string
required

Single tool name prefixed by the datasource type. Diagnostic tools are defined by the executing Edge (e.g. mysql.overview). Query tools are <type>.query where <type> is one of prometheus, mysql, postgres, oracle, clickhouse, elasticsearch, loki, victorialogs, sls, tencent_cls; their params follow PrometheusQueryParams, MySQLQueryParams, PostgresQueryParams, OracleQueryParams, ClickHouseQueryParams, ElasticsearchQueryParams, LokiQueryParams, VictoriaLogsQueryParams, SLSQueryParams, or TencentCLSQueryParams respectively.

Required string length: 1 - 128
account_id
integer<uint64>

Optional consistency check; must equal the authenticated account.

params
object

Tool-specific JSON parameters; omitted means {}. Explicit null is invalid. Query tools (<type>.query) use the per-datasource params schemas named in the tool description.

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

Endpoint-specific payload. See each operation's 200 response schema.