Skip to main content
POST
Get service map status

Restrictions

Usage

  • ServiceMap is an optional subsystem: a deployment without redis.servicemap configured returns ServiceUnavailable.
  • Exactly one selection mode is used per call: explicit host_id/host_ids, or fleet=true; combining fleet=true with either host field is rejected.
  • Unlike POST /monit/servicemap/topology and POST /monit/servicemap/summary, an unresolvable host does not fail the whole request — it is reported per item via items[].error_code.
  • limit (default 100, max 200) bounds the number of explicit hosts accepted, and in fleet mode, the number of candidate hosts sampled.

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

Selects which hosts to fetch collection status for: explicit host IDs, or a bounded fleet sample.

host_id
string

A single host ID to check. Combine with host_ids to check several; mutually exclusive with fleet=true.

Maximum string length: 128
Pattern: ^host_[a-z0-9_-]+$
host_ids
string[]

Multiple host IDs to check in one call, up to 200 combined with host_id. Mutually exclusive with fleet=true.

fleet
boolean
default:false

When true, ignore host_id/host_ids and instead sample up to limit fleet candidate hosts for the account. Default false.

limit
integer
default:100

In fleet mode, the number of candidate hosts to sample. Ignored otherwise. Default 100, range 1-200.

Required range: 1 <= x <= 200

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

ServiceMap collection status for the requested hosts.