> ## 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. # Get service map summary > Return a bounded, AI-ready summary of a host's outbound service dependencies. ## Restrictions | Aspect | Value | | ----------- | --------------------------------------------------------- | | Rate limits | **30 requests/minute**; **2 requests/second** per account | | Permissions | **Service Map Read** (`monit`) | ## Usage * ServiceMap is an optional subsystem: a deployment without `redis.servicemap` configured returns `ServiceUnavailable`. * `anchor.host_id` must already be known to ServiceMap; otherwise this returns `ResourceNotFound`. * This is a fixed-size digest, not a scaled-down `POST /monit/servicemap/topology`: depth is always 1 and neighbors are capped at 12, and none of the sizing is caller-adjustable. * `context_ref_detail` is a pre-rendered natural-language evidence string designed for LLM prompts; the structured fields are the source of truth and this is a convenience rendering of them. * `graph_role=last_known_good` means the latest ingestion is unhealthy and the summary reflects the last authoritative graph rather than a live one. ## OpenAPI ````yaml /api-reference/monitors.openapi.en.json post /monit/servicemap/summary 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/summary: post: tags: - Monitors/Service map summary: Get service map summary description: >- Return a bounded, AI-ready summary of a host's outbound service dependencies. operationId: monit-servicemap-read-summary requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/ServiceMapSummaryRequest' example: anchor: host_id: host_0123456789abcdef0123456789abcdef responses: '200': description: Success content: application/json: schema: allOf: - $ref: '#/components/schemas/SuccessEnvelope' - type: object properties: data: $ref: '#/components/schemas/ServiceMapSummaryResponse' example: request_id: 01HK8XQE3Z7JM2NTFQ5YJ8P9R4 data: network_scope_id: ns_0123456789abcdef0123456789abcdef anchor_host_id: host_0123456789abcdef0123456789abcdef status: active authoritative: true graph_role: current latest_collection_authoritative: true observed_at_ms: 1784635556072 received_at_ms: 1784635557272 freshness: status: fresh newest_received_at_ms: 1784635557272 oldest_received_at_ms: 1784635557272 max_age_ms: 1200 coverage: direction: outbound hosts_loaded: 2 degraded_hosts: 0 truncated_hosts: 0 capture_modes: - ebpf network_inventory_status: complete kubernetes_enrichment_status: unavailable truncated: false resolution_counts: resolved: 1 ambiguous: 0 unresolved: 0 neighbors: - edge_id: edge_v1_example source_entity_id: procw_v1_source source_display_name: orders.service resolution_status: resolved target_host_id: host_fedcba9876543210fedcba9876543210 target_entity_id: procw_v1_mysql target_display_name: mysqld.service destination_protocol: tcp destination_ip: 203.0.113.105 destination_port: 3306 last_seen: '2026-07-21T18:45:56.072+08:00' active_connections: 1 context_ref_detail: >- ServiceMap current bounded evidence: anchor_host_id=host_0123456789abcdef0123456789abcdef; observed_at_ms=1784635556072; received_at_ms=1784635557272; latest_health_at_ms=0; status=active; freshness=fresh; graph_authoritative=true; latest_collection_authoritative=true; coverage_hosts=2; resolution_counts=resolved:1,ambiguous:0,unresolved:0; truncated=false. Observed outbound relations (relations_shown=1/1): [orders.service -> mysqld.service, resolution=resolved, last_seen=2026-07-21T18:45:56.072+08:00] Evidence rules: only resolution=resolved relations are certain; treat ambiguous/unresolved relations as leads to verify, not fact. '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: ServiceMapSummaryRequest: type: object description: Query parameters for the bounded, AI-ready dependency summary. required: - anchor properties: anchor: $ref: '#/components/schemas/ServiceMapAnchor' description: Host (and optional entity) to summarize. network_scope_id: type: string description: >- Optional integrity check: if set, must match the network scope already associated with `anchor.host_id`, or the request is rejected with `InvalidParameter`. 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 ServiceMapSummaryResponse: type: object description: A bounded, AI-ready summary of a host's outbound service dependencies. required: - network_scope_id - anchor_host_id - status - authoritative - graph_role - latest_collection_authoritative - observed_at_ms - received_at_ms - freshness - coverage - truncated - resolution_counts - neighbors - context_ref_detail properties: network_scope_id: type: string description: Network scope the summary was resolved within. anchor_host_id: type: string description: Echo of the requested anchor host ID. anchor_entity_id: type: string description: Echo of the requested anchor entity ID, when one was given. status: type: string enum: - active - degraded - stale - initializing - disabled - unsupported - no_data description: >- ServiceMap collection status of the anchor host. | 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. | authoritative: type: boolean description: >- Always `true`; the summary is only ever built from an authoritative graph. graph_role: type: string enum: - current - last_known_good description: >- `current` if the summary reflects the live graph; `last_known_good` if the latest ingestion is unhealthy and this reflects the last authoritative graph instead. latest_collection_authoritative: type: boolean description: >- False when `graph_role=last_known_good`, i.e. the most recent collection attempt was not authoritative. latest_health_at_ms: type: integer format: int64 description: >- Unix timestamp in milliseconds of the most recent non-authoritative health signal, when more recent than the current graph. observed_at_ms: type: integer format: int64 description: >- Unix timestamp in milliseconds the underlying data was observed by the agent. received_at_ms: type: integer format: int64 description: >- Unix timestamp in milliseconds the current graph generation was received by the server. freshness: $ref: '#/components/schemas/ServiceMapFreshness' description: How recent the graph data is. coverage: $ref: '#/components/schemas/ServiceMapTopologyCoverage' description: >- Aggregate coverage and enrichment status for the anchor host's graph. truncated: type: boolean description: >- True if the fixed-size summary omitted any neighbor or coverage detail to stay within its bounds. truncation_reasons: type: array description: >- Machine-readable reasons the summary was truncated, when `truncated=true`. items: type: string resolution_counts: $ref: '#/components/schemas/ServiceMapResolutionCounts' description: >- Counts of the anchor host's outbound relations by resolution outcome. neighbors: type: array description: Up to 12 outbound relations, most informative first. items: $ref: '#/components/schemas/ServiceMapSummaryNeighbor' context_ref_detail: type: string description: >- Pre-rendered natural-language evidence string summarizing this response, designed for LLM prompts. The structured fields above are the source of truth; this is a convenience rendering of them. ServiceMapAnchor: type: object description: >- Identifies the host (and optionally the specific process/entity) to anchor the query on. required: - host_id properties: host_id: type: string description: >- Stable ServiceMap host identifier, e.g. `host_0123...`. Must already be known to ServiceMap. pattern: ^host_[a-z0-9_-]+$ maxLength: 128 entity_id: type: string description: >- Optional process/entity ID within the host to anchor on. Omit to anchor on the whole host. ServiceMapFreshness: type: object description: Describes how recent the underlying graph data is. required: - status - newest_received_at_ms - oldest_received_at_ms - max_age_ms properties: status: type: string enum: - fresh - stale - unknown description: >- Freshness classification. `fresh` = the latest snapshot was received within 2× the report interval; `stale` = no new snapshot within 2× the report interval; `unknown` = no snapshot data, undecidable. newest_received_at_ms: type: integer format: int64 description: >- Unix timestamp in milliseconds of the most recently received graph among the hosts covered. oldest_received_at_ms: type: integer format: int64 description: >- Unix timestamp in milliseconds of the least recently received graph among the hosts covered. max_age_ms: type: integer format: int64 description: Age in milliseconds of the staleest graph covered, relative to now. ServiceMapTopologyCoverage: type: object description: >- Aggregate coverage and enrichment status across every host graph loaded to answer the query. required: - direction - hosts_loaded - degraded_hosts - truncated_hosts - network_inventory_status - kubernetes_enrichment_status - listener_address_family_status properties: direction: type: string enum: - outbound description: >- Always `outbound`; ServiceMap currently only models outbound relations. hosts_loaded: type: integer format: int64 description: Number of distinct host graphs loaded to answer the query. degraded_hosts: type: integer format: int64 description: Number of loaded host graphs that were degraded at collection time. truncated_hosts: type: integer format: int64 description: Number of loaded host graphs that were truncated at collection time. capture_modes: type: array description: Distinct capture modes (e.g. `ebpf`) seen across loaded hosts. items: type: string network_inventory_status: type: string enum: - unknown - complete - partial - unavailable description: >- Aggregate network-inventory enrichment coverage across loaded hosts (worst per-host status wins). | Value | Meaning | |---|---| | `complete` | Every requested network namespace on every host was scanned successfully with no errors. | | `partial` | At least one host failed to scan some namespaces, or scanning raised errors. | | `unavailable` | At least one host failed to scan all of its namespaces. | | `unknown` | No host loaded, or a host reported an unrecognized status. | kubernetes_enrichment_status: type: string enum: - unknown - complete - partial - unavailable description: >- Aggregate Kubernetes enrichment coverage across loaded hosts (worst per-host status wins). | Value | Meaning | |---|---| | `complete` | Every host has full pod-binding metadata for its entities. | | `partial` | At least one host has bindings but some pod metadata is missing or bindings were dropped. | | `unavailable` | At least one host has no pod bindings at all. | | `unknown` | No host loaded, or a host reported an unrecognized status. | listener_address_family_status: type: string enum: - unknown - complete - partial - unavailable description: >- Aggregate listener address-family (IPv4/IPv6) resolution coverage across loaded hosts (worst per-host status wins). | Value | Meaning | |---|---| | `complete` | On every host, the IPv6-only attribute of all IPv6 wildcard listeners is known. | | `partial` | At least one host knows the IPv6-only attribute for only some IPv6 wildcard listeners. | | `unavailable` | At least one host knows the IPv6-only attribute of none of its IPv6 wildcard listeners. | | `unknown` | No host loaded, or a host reported an unrecognized status. | ipv6_wildcard_listener_count: type: integer format: int64 description: Number of IPv6 wildcard (unspecified-address) listeners observed. ipv6_only_known_listener_count: type: integer format: int64 description: Number of IPv6 wildcard listeners with a known IPV6_V6ONLY setting. ipv6_only_unknown_listener_count: type: integer format: int64 description: >- Number of IPv6 wildcard listeners whose IPV6_V6ONLY setting could not be determined. reasons: type: array description: >- Machine-readable reason codes explaining any degraded or truncated state among loaded hosts. items: type: string ServiceMapResolutionCounts: type: object description: Counts of edges by resolution outcome. required: - resolved - ambiguous - unresolved properties: resolved: type: integer description: Number of edges resolved to exactly one confident candidate. ambiguous: type: integer description: Number of edges resolved to multiple or low-confidence candidates. unresolved: type: integer description: Number of edges with no resolvable candidate. ServiceMapSummaryNeighbor: type: object description: >- One outbound relation folded into the summary, in a compact shape optimized for prompts. required: - edge_id - source_entity_id - resolution_status properties: edge_id: type: string description: Edge ID. source_entity_id: type: string description: Entity ID of the source node. source_display_name: type: string description: Display name of the source node, when known. resolution_status: type: string enum: - resolved - ambiguous - unresolved description: >- Resolution outcome for this relation's destination. `resolved` = uniquely resolved to a listening entity on a host — the relation is reliable; `ambiguous` = multiple candidates exist (or the listener address family is unknown) — treat the relation as a lead to verify; `unresolved` = no candidate found, the destination identity is unknown. target_host_id: type: string description: >- Host ID of the resolved target, when `resolution_status=resolved` and unambiguous. target_entity_id: type: string description: >- Entity ID of the resolved target, when `resolution_status=resolved` and unambiguous. target_display_name: type: string description: Display name of the resolved target, when known. destination_protocol: type: string enum: - tcp - udp description: >- Transport protocol of the destination. `tcp` = TCP connection; `udp` = UDP session. Collectors currently only report `tcp`; `udp` is reserved. destination_ip: type: string description: Destination IP address. destination_port: type: integer description: Destination port. last_seen: type: string format: date-time description: Timestamp this relation was last observed. active_connections: type: - integer - 'null' format: int64 description: >- Active connection count for this relation, when the underlying agent reports it. 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 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. ````