Skip to main content
POST
Get service map fleet summary

Restrictions

Usage

  • Like POST /monit/servicemap/fleet, this endpoint degrades gracefully when the ServiceMap store is unavailable rather than failing the whole request.
  • This is a single-request, unpaginated aggregate over up to scan_limit hosts (default 2000, max 5000) — it does not return per-host detail or accept a status filter.
  • Reaching scan_limit before scanning the whole account sets truncated=true; coverage.states reflects only the hosts actually scanned, not the account’s full population.

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

Filter parameters for the aggregate fleet status distribution.

scan_limit
integer
default:2000

Maximum number of candidate hosts to scan. Default 2000, range 1-5000.

Required range: 1 <= x <= 5000
agent_versions
string[]

Filter to hosts on any of these exact agent versions. Up to 20 values.

Maximum array length: 20
edge_clusters
string[]

Filter to hosts in any of these exact edge cluster names. Up to 20 values.

Maximum array length: 20
capture_modes
enum<string>[]

Filter to hosts using any of these capture modes. unknown matches hosts that have not reported a capture mode yet.

Maximum array length: 3
Available options:
ebpf,
polling,
unknown

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

Aggregate status distribution across the account's ServiceMap-capable hosts.