Skip to main content
POST
/
monit
/
targets
List monitored targets
curl --request POST \
  --url 'https://api.flashcat.cloud/monit/targets?app_key=' \
  --header 'Content-Type: application/json' \
  --data '
{
  "keyword": "db-prod",
  "limit": 50
}
'
{
  "request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4",
  "data": {
    "items": [
      {
        "target_kind": "host",
        "target_locator": "db-prod-01",
        "agent_version": "2.0.0",
        "cluster_name": "edge-a",
        "edge_ipport": "10.0.0.1:19090",
        "updated_at": 1710000000
      }
    ],
    "total": 120,
    "next_cursor": "eyJ0YXJnZXRfbG9jYXRvciI6ImRiLXByb2QtMDEiLCJpZCI6MTIzNDV9"
  }
}

​
Restrictions

AspectValue
Rate limits600 requests/minute; 10 requests/second per account
PermissionsAny valid app_key (read-only; not gated by a specific permission class)

​
Usage

  • This is a UI projection view, not the live source-of-truth used by /monit/tools/invoke. A row in the list is no guarantee the target is currently invokable.
  • keyword is a prefix match against target_locator (ASCII-only, no whitespace, no |, max 256 bytes). Substring search is not supported in v1.
  • limit defaults to 50, max 200. Pagination is cursor-based: pass the previous response’s next_cursor to fetch the next page; an empty / missing next_cursor means the last page.
  • Resetting keyword, limit, or the tenant context requires resetting cursor; never mix a cursor across different filter sets.
  • total is the unfiltered-by-cursor match count for the current (account_id, keyword) pair and stays stable across pages.
  • Fields surface cluster_name / edge_ipport for diagnostics; treat updated_at as “most recently observed” rather than a live online indicator.

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
​
account_id
integer<int64>

Optional consistency check. Must equal the authenticated account when supplied.

​
keyword
string

Prefix match against target_locator. ASCII only, no whitespace, no |, max 256 bytes. Substring search is not supported.

​
limit
integer
default:50

Page size. Default 50, max 200.

Required range: x <= 200
​
cursor
string

Opaque pagination cursor from the previous response's next_cursor. Omit / pass empty string for the first page. Reset whenever keyword, limit, or tenant changes.

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.