Skip to main content
POST
Browse service map fleet hosts

Restrictions

Usage

  • Unlike the other four ServiceMap read APIs, this endpoint degrades gracefully when the ServiceMap store is unavailable: matching still runs off inventory data, and affected items report servicemap.error_code=status_unavailable with partial=true, instead of the whole request failing.
  • cursor is opaque — pass back the exact value from next_cursor; do not construct or parse it.
  • Reaching scan_limit before limit matches are found sets truncated=true with next_cursor still populated — this is not the same as reaching the end of the account’s hosts.
  • coverage.scanned/matched/returned describe this page’s scan only, not the account’s total host 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 and pagination parameters for browsing ServiceMap-capable hosts.

cursor
string

Opaque pagination cursor. Pass back the exact value from a previous response's next_cursor; omit for the first page.

limit
integer
default:50

Maximum number of matching hosts to return in this page. Default 50, range 1-100.

Required range: 1 <= x <= 100
scan_limit
integer
default:1000

Maximum number of candidate hosts to examine while filling this page. Default 1000, range limit-2000.

Required range: x <= 2000
statuses
enum<string>[]

Filter to hosts currently in any of these statuses. Up to 20 values.

Maximum array length: 20
Available options:
active,
degraded,
stale,
initializing,
disabled,
unsupported,
no_data
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

A page of hosts matching the fleet browse filters.