> ## Documentation Index > Fetch the complete documentation index at: https://docs.flashduty.com/llms.txt > Use this file to discover all available pages before exploring further. # Browse service map fleet hosts > Browse the account's hosts with ServiceMap capability and current collection status. ## Restrictions | Aspect | Value | | ----------- | --------------------------------------------------------- | | Rate limits | **30 requests/minute**; **2 requests/second** per account | | Permissions | **Targets Read** (`monit`) | ## 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. ## OpenAPI ````yaml /api-reference/monitors.openapi.en.json post /monit/servicemap/fleet openapi: 3.1.0 info: title: Flashduty Open API description: >- Public HTTP API for the Flashduty incident management platform — incidents, notification templates, channels, schedules, monitors, RUM, and platform administration. Every operation is authenticated with an `app_key` query parameter issued from the Flashduty console under Account → APP Keys. Responses follow a uniform envelope: `{ request_id, data }` on success, `{ request_id, error }` on failure. version: 1.0.0 servers: - url: https://api.flashcat.cloud description: Flashduty Open API security: - AppKeyAuth: [] tags: - name: Monitors/Alert rules description: >- Create, manage, and export monitor alert rules. Query rule counters and audit history. - name: Monitors/Data sources description: Manage monitoring data sources used by alert rules to query metrics. - name: Monitors/Rule sets description: >- Manage shared rule sets (rulesets) in the Monitors rule repository. Rulesets can be shared publicly or within an account. - name: Monitors/Diagnostics description: >- Diagnostic and query endpoints used by Flashduty AI SRE — ad-hoc data source queries, log/metric diagnostics, and target-side tool invocation. - name: Monitors/Monitor utilities description: Monitors service activation and data preview utilities. - name: Monitors/Service map description: >- Query network-observed service topology, dependency summaries, and ServiceMap collection status across hosts. paths: /monit/servicemap/fleet: post: tags: - Monitors/Service map summary: Browse service map fleet hosts description: >- Browse the account's hosts with ServiceMap capability and current collection status. operationId: monit-servicemap-read-fleet requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/ServiceMapFleetBrowseRequest' example: limit: 50 scan_limit: 1000 statuses: - degraded - stale agent_versions: - v1.2.3 edge_clusters: - edge-a capture_modes: - ebpf responses: '200': description: Success content: application/json: schema: allOf: - $ref: '#/components/schemas/SuccessEnvelope' - type: object properties: data: $ref: '#/components/schemas/ServiceMapFleetBrowseResponse' example: request_id: 01HK8XQE3Z7JM2NTFQ5YJ8P9R4 data: items: - host_id: host_0123456789abcdef0123456789abcdef agent_version: v1.2.3 edge_cluster: edge-a servicemap: enabled: true status: degraded capability_status: degraded capture_mode: ebpf snapshot_ready: true authoritative: true graph_available: false freshness_status: fresh observed_at_ms: 1784635557272 received_at_ms: 1784635557272 node_count: 46 edge_count: 200 reason_codes: - snapshot_incomplete - host_id: host_fedcba9876543210fedcba9876543210 agent_version: v1.2.3 edge_cluster: edge-a servicemap: enabled: true status: stale capability_status: running capture_mode: ebpf snapshot_ready: true authoritative: true graph_available: true freshness_status: stale observed_at_ms: 1784631957272 received_at_ms: 1784631957272 node_count: 38 edge_count: 152 coverage: scanned: 80 matched: 2 returned: 2 failed: 0 states: active: 0 degraded: 1 stale: 1 initializing: 0 disabled: 0 unsupported: 0 no_data: 0 partial: false truncated: false generated_at_ms: 1784635557272 '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '429': $ref: '#/components/responses/TooManyRequests' '500': $ref: '#/components/responses/ServerError' '503': $ref: '#/components/responses/ServiceUnavailable' components: schemas: ServiceMapFleetBrowseRequest: type: object description: Filter and pagination parameters for browsing ServiceMap-capable hosts. properties: cursor: type: string description: >- Opaque pagination cursor. Pass back the exact value from a previous response's `next_cursor`; omit for the first page. limit: type: integer description: >- Maximum number of matching hosts to return in this page. Default 50, range 1-100. default: 50 minimum: 1 maximum: 100 scan_limit: type: integer description: >- Maximum number of candidate hosts to examine while filling this page. Default 1000, range `limit`-2000. default: 1000 maximum: 2000 statuses: type: array description: Filter to hosts currently in any of these statuses. Up to 20 values. items: type: string enum: - active - degraded - stale - initializing - disabled - unsupported - no_data maxItems: 20 agent_versions: type: array description: >- Filter to hosts on any of these exact agent versions. Up to 20 values. items: type: string maxItems: 20 edge_clusters: type: array description: >- Filter to hosts in any of these exact edge cluster names. Up to 20 values. items: type: string maxItems: 20 capture_modes: type: array description: >- Filter to hosts using any of these capture modes. `unknown` matches hosts that have not reported a capture mode yet. items: type: string enum: - ebpf - polling - unknown maxItems: 3 SuccessEnvelope: type: object description: >- 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`. properties: request_id: type: string description: >- Unique ID for this request. Mirrored in the Flashcat-Request-Id response header. Include it when reporting issues. example: 01HK8XQE3Z7JM2NTFQ5YJ8P9R4 data: description: Endpoint-specific payload. See each operation's 200 response schema. required: - request_id - data ServiceMapFleetBrowseResponse: type: object description: A page of hosts matching the fleet browse filters. required: - items - coverage - partial - truncated - generated_at_ms properties: items: type: array description: Matching hosts for this page. items: $ref: '#/components/schemas/ServiceMapFleetHost' coverage: $ref: '#/components/schemas/ServiceMapFleetCoverage' description: Coverage of the candidate scan that produced this page. partial: type: boolean description: >- True if any host in this page failed to read status, or the scan was truncated. truncated: type: boolean description: >- True if `scan_limit` was reached before finding `limit` matches; `next_cursor` may still find more. truncation_reasons: type: array description: >- Machine-readable reasons the scan was truncated, when `truncated=true`. items: type: string next_cursor: type: string description: >- Opaque cursor to fetch the next page. Absent when there are no more candidates to scan. generated_at_ms: type: integer format: int64 description: Unix timestamp in milliseconds this response was generated. ServiceMapFleetHost: type: object description: One host matched by the fleet browse filters. required: - host_id - agent_version - edge_cluster - servicemap properties: host_id: type: string description: Stable ServiceMap host identifier. agent_version: type: string description: Agent version reported by this host. edge_cluster: type: string description: Edge cluster name this host belongs to. servicemap: $ref: '#/components/schemas/ServiceMapFleetHostCapability' description: ServiceMap capability and current collection status for this host. ServiceMapFleetCoverage: type: object description: Coverage of the candidate scan that produced this page. required: - scanned - matched - returned - failed - states properties: scanned: type: integer description: >- Number of distinct candidate hosts actually examined in this request. matched: type: integer description: Number of scanned hosts that passed all filters. returned: type: integer description: Number of matched hosts included in this page (`<= limit`). failed: type: integer description: Number of candidate hosts whose status could not be read. states: type: object description: >- Count of returned items per status value; always includes all seven status keys, zero-filled. Reflects only this page, not the account's full population. additionalProperties: type: integer ErrorResponse: type: object description: Response envelope for errors. `error` is required; `data` is absent. properties: request_id: type: string example: 01HK8XQE3Z7JM2NTFQ5YJ8P9R4 description: >- Unique trace ID of this request; include it when reporting issues so logs can be located. error: $ref: '#/components/schemas/DutyError' required: - request_id - error ServiceMapFleetHostCapability: type: object description: >- A fleet-listed host's ServiceMap capability and current collection status, joined from inventory and live state. required: - enabled - status - snapshot_ready - authoritative - graph_available - node_count - edge_count properties: enabled: type: boolean description: True if ServiceMap collection is enabled on this host. status: type: string enum: - active - degraded - stale - initializing - disabled - unsupported - no_data description: >- Overall ServiceMap collection status. | Value | Meaning | |---|---| | `active` | Collection healthy: a fresh snapshot exists with no degradation. | | `degraded` | Collecting but quality is impaired: health reports are newer than the snapshot, the snapshot is truncated/degraded, or collection is failing. | | `stale` | A snapshot exists but is outdated (not updated within 2× the report interval). | | `initializing` | The agent has reported the capability but the first snapshot is not ready yet. | | `disabled` | Topology collection is disabled on this host. | | `unsupported` | The agent or kernel does not support this collection. | | `no_data` | No snapshot or health data received at all. | capability_status: type: string description: >- Agent-reported capability status, e.g. `running`, `disabled`, `starting`, `failed`, `unsupported`. capture_mode: type: string description: Capture mode, e.g. `ebpf` or `polling`. report_interval_ms: type: integer format: int64 description: Configured reporting interval in milliseconds. snapshot_ready: type: boolean description: True if the agent has produced at least one full snapshot. authoritative: type: boolean description: True if the host has an authoritative current graph. graph_available: type: boolean description: True if a current graph can be fetched for this host right now. freshness_status: type: string enum: - fresh - stale - unknown description: >- Freshness classification of the host's graph. `fresh` = the latest snapshot was received within 2× the report interval; `stale` = no new snapshot within 2× the report interval; `unknown` = no topology snapshot ever received, freshness undecidable. max_age_ms: type: integer format: int64 description: >- Age in milliseconds of the host's graph data, relative to when this response was generated. observed_at_ms: type: integer format: int64 description: >- Unix timestamp in milliseconds the host's graph was observed by the agent. received_at_ms: type: integer format: int64 description: >- Unix timestamp in milliseconds the host's current graph generation was received by the server. node_count: type: integer description: Number of nodes in the host's current graph. edge_count: type: integer description: Number of edges in the host's current graph. reason_codes: type: array description: Machine-readable codes explaining the current status. items: type: string error_code: type: string description: >- Set to `status_unavailable` when this host's live status could not be read; other fields fall back to inventory-derived defaults in that case. DutyError: type: object description: >- Error payload inside the response envelope. Present only on non-2xx responses. properties: code: $ref: '#/components/schemas/ErrorCode' message: type: string description: >- Human-readable error message, localized by the caller's Accept-Language. May contain field names, IDs, or other context from the failing request. example: The specified parameter template_id is not valid. required: - code - message ErrorCode: type: string description: >- Flashduty error code enum. Every failed API response sets `error.code` to one of these stable wire strings. HTTP status is informational — the authoritative signal is the enum value. | Code | HTTP | Meaning | |---|---|---| | `OK` | 200 | Reserved — not returned on real errors. | | `InvalidParameter` | 400 | A required parameter is missing or failed validation. | | `BadRequest` | 400 | Generic 400 used when no more specific code fits. | | `InvalidContentType` | 400 | The `Content-Type` header is not `application/json`. | | `ResourceNotFound` | 400 | The referenced resource does not exist. Note: returned as HTTP 400, not 404 (historical choice). | | `NoLicense` | 400 | The feature is license-gated and no active license was found. | | `ReferenceExist` | 400 | Deletion blocked — other entities still reference this resource. | | `Unauthorized` | 401 | `app_key` is missing, invalid, or expired. | | `BalanceNotEnough` | 402 | Billing-gated operation with insufficient account balance. | | `AccessDenied` | 403 | Authenticated but lacking the permission required for this operation. | | `RouteNotFound` | 404 | The request URL path is not a known route. | | `MethodNotAllowed` | 405 | The HTTP method is not allowed on this otherwise-known path. | | `UndonedOrderExist` | 409 | An outstanding billing order blocks this new one. Wait and retry. | | `RequestLocked` | 423 | Operation temporarily locked due to repeated failures. | | `EntityTooLarge` | 413 | Request body exceeds the configured max size. | | `RequestTooFrequently` | 429 | Rate limit hit — API-global, per-account, or per-integration. | | `RequestVerifyRequired` | 428 | Second-factor verification required but not supplied. | | `DangerousOperation` | 428 | High-risk operation requires MFA verification. | | `InternalError` | 500 | Unhandled server-side error. Include `request_id` in the bug report. | | `ServiceUnavailable` | 503 | A backend dependency is unavailable. Try again later. | enum: - OK - InvalidParameter - BadRequest - InvalidContentType - ResourceNotFound - NoLicense - ReferenceExist - Unauthorized - BalanceNotEnough - AccessDenied - RouteNotFound - MethodNotAllowed - UndonedOrderExist - RequestLocked - EntityTooLarge - RequestTooFrequently - RequestVerifyRequired - DangerousOperation - InternalError - ServiceUnavailable x-enumDescriptions: OK: Reserved — not returned on real errors. InvalidParameter: A required parameter is missing or failed validation. BadRequest: Generic 400 used when no more specific code fits. InvalidContentType: The `Content-Type` header is not `application/json`. ResourceNotFound: >- The referenced resource does not exist. Note: returned as HTTP 400, not 404 (historical choice). NoLicense: The feature is license-gated and no active license was found. ReferenceExist: Deletion blocked — other entities still reference this resource. Unauthorized: '`app_key` is missing, invalid, or expired.' BalanceNotEnough: Billing-gated operation with insufficient account balance. AccessDenied: Authenticated but lacking the permission required for this operation. RouteNotFound: The request URL path is not a known route. MethodNotAllowed: The HTTP method is not allowed on this otherwise-known path. UndonedOrderExist: An outstanding billing order blocks this new one. Wait and retry. RequestLocked: Operation temporarily locked due to repeated failures. EntityTooLarge: Request body exceeds the configured max size. RequestTooFrequently: Rate limit hit — API-global, per-account, or per-integration. RequestVerifyRequired: Second-factor verification required but not supplied. DangerousOperation: High-risk operation requires MFA verification. InternalError: Unhandled server-side error. Include `request_id` in the bug report. ServiceUnavailable: A backend dependency is unavailable. Try again later. example: InvalidParameter responses: BadRequest: description: Invalid request — usually a missing or malformed parameter. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' examples: missingParameter: value: request_id: 01HK8XQE3Z7JM2NTFQ5YJ8P9R4 error: code: InvalidParameter message: The specified parameter is not valid. Unauthorized: description: Missing or invalid app_key. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' examples: missingAppKey: value: request_id: 01HK8XQE3Z7JM2NTFQ5YJ8P9R4 error: code: Unauthorized message: You are unauthorized. TooManyRequests: description: >- Rate limit hit. Either the global API limit, a per-account limit, or a per-integration limit. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' examples: rateLimited: value: request_id: 01HK8XQE3Z7JM2NTFQ5YJ8P9R4 error: code: RequestTooFrequently message: Request too frequently. ServerError: description: Unexpected server-side error. Include the request_id when reporting. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' examples: internal: value: request_id: 01HK8XQE3Z7JM2NTFQ5YJ8P9R4 error: code: InternalError message: >- We encountered an internal error, and it has been reported. Please try again later. ServiceUnavailable: description: >- The ServiceMap subsystem is not enabled or not reachable on this deployment. Include the request_id when reporting. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' examples: serviceMapDisabled: value: request_id: 01HK8XQE3Z7JM2NTFQ5YJ8P9R4 error: code: ServiceUnavailable message: servicemap store is not initialized securitySchemes: AppKeyAuth: type: apiKey in: query name: app_key description: >- 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. ````