> ## Documentation Index > Fetch the complete documentation index at: https://www.worldmonitor.app/docs/llms.txt > Use this file to discover all available pages before exploring further. # GetCableHealth > GetCableHealth computes health status for submarine cables from NGA maritime warning signals. ## OpenAPI ````yaml /api/InfrastructureService.openapi.yaml get /api/infrastructure/v1/get-cable-health openapi: 3.1.0 info: title: InfrastructureService API version: 1.0.0 servers: - url: https://api.worldmonitor.app security: - WorldMonitorKey: [] - ApiKeyHeader: [] paths: /api/infrastructure/v1/get-cable-health: get: tags: - InfrastructureService summary: GetCableHealth description: >- GetCableHealth computes health status for submarine cables from NGA maritime warning signals. operationId: GetCableHealth parameters: - name: jmespath in: query description: >- Optional JMESPath expression applied server-side to project or reduce the JSON response before it is returned (mirrors the MCP jmespath argument). Invalid expressions, expressions larger than 1024 UTF-8 bytes, or projections that exceed the 256 KB output cap return HTTP 400 with a {_jmespath_error, original_keys} envelope. Grammar and worked examples: https://www.worldmonitor.app/docs/mcp-jmespath. required: false example: keys(@) schema: type: string responses: '200': description: Successful response content: application/json: example: cables: exampleKey: confidence: 0.82 evidence: - source: example summary: Example WorldMonitor observation. ts: 1 lastUpdated: 1 score: 42.5 status: CABLE_HEALTH_STATUS_OK generatedAt: 1717200000000 schema: $ref: '#/components/schemas/GetCableHealthResponse' '400': description: Validation error content: application/json: schema: oneOf: - $ref: '#/components/schemas/ValidationError' - $ref: '#/components/schemas/JmespathProjectionError' '401': description: Missing or invalid API key. content: application/json: schema: $ref: '#/components/schemas/UnauthorizedError' '403': description: >- API access requires an active subscription (the API key's subscription is inactive or expired). content: application/json: schema: $ref: '#/components/schemas/ForbiddenError' '429': description: Rate limit exceeded. headers: X-RateLimit-Limit: description: Maximum requests allowed in the active rate-limit window. schema: type: string X-RateLimit-Remaining: description: Requests remaining in the active rate-limit window. schema: type: string X-RateLimit-Reset: description: >- Unix epoch milliseconds when the active rate-limit window resets. schema: type: string Retry-After: description: Seconds to wait before retrying the request. schema: type: string content: application/json: schema: oneOf: - $ref: '#/components/schemas/Error' - $ref: '#/components/schemas/RateLimitError' default: description: Gateway or handler error response. content: application/json: schema: oneOf: - $ref: '#/components/schemas/Error' - $ref: '#/components/schemas/GatewayError' components: schemas: GetCableHealthResponse: type: object properties: generatedAt: type: integer format: int64 description: >- Generation timestamp, as Unix epoch milliseconds.. Warning: Values > 2^53 may lose precision in JavaScript cables: type: object additionalProperties: $ref: '#/components/schemas/CableHealthRecord' description: Health records keyed by cable identifier. description: >- GetCableHealthResponse contains health status for submarine cables with active signals. ValidationError: type: object properties: violations: type: array items: $ref: '#/components/schemas/FieldViolation' description: List of validation violations required: - violations description: >- ValidationError is returned when request validation fails. It contains a list of field violations describing what went wrong. JmespathProjectionError: description: >- Returned when a REST jmespath projection is invalid or exceeds the expression/output byte limits. properties: _jmespath_error: description: Projection error discriminator and details. type: string original_keys: description: Top-level keys or shape of the unprojected response. items: type: string type: array required: - _jmespath_error - original_keys type: object UnauthorizedError: type: object properties: error: type: string description: Human-readable error message. required: - error description: >- Returned when the API key is missing, malformed, or lacks current API access. ForbiddenError: type: object properties: error: type: string description: Human-readable entitlement failure reason. requiredTier: type: integer format: int32 description: Minimum entitlement tier required for this endpoint. currentTier: type: integer format: int32 description: Caller entitlement tier when known. planKey: type: string description: Caller plan key when known. required: - error description: >- Returned when a PRO-gated endpoint denies access because the caller has no resolved authenticated user, entitlements cannot be verified, or the caller lacks the required entitlement tier. Error: type: object properties: message: type: string description: Error message (e.g., 'user not found', 'database connection failed') description: >- Error is returned when a handler encounters an error. It contains a simple error message that the developer can customize. RateLimitError: type: object description: Returned when a gateway or handler rate limit rejects the request. properties: error: type: string description: Human-readable rate-limit failure reason. required: - error GatewayError: type: object description: >- Returned by gateway infrastructure errors before an RPC handler runs, such as origin, routing, method, authentication, or quota checks. properties: error: oneOf: - type: string - type: object additionalProperties: true description: Gateway error reason or structured gateway failure details. required: - error CableHealthRecord: type: object properties: status: type: string enum: - CABLE_HEALTH_STATUS_UNSPECIFIED - CABLE_HEALTH_STATUS_OK - CABLE_HEALTH_STATUS_DEGRADED - CABLE_HEALTH_STATUS_FAULT description: >- CableHealthStatus represents the computed health status of a submarine cable. score: type: number format: double description: Composite health score (0.0 = healthy, 1.0 = confirmed fault). confidence: type: number format: double description: Confidence in the health assessment (0.0–1.0). lastUpdated: type: integer format: int64 description: >- Last signal update time, as Unix epoch milliseconds.. Warning: Values > 2^53 may lose precision in JavaScript evidence: type: array items: $ref: '#/components/schemas/CableHealthEvidence' description: >- CableHealthRecord contains the computed health status and supporting evidence for a cable. FieldViolation: type: object properties: field: type: string description: >- The field path that failed validation (e.g., 'user.email' for nested fields). For header validation, this will be the header name (e.g., 'X-API-Key') description: type: string description: >- Human-readable description of the validation violation (e.g., 'must be a valid email address', 'required field missing') required: - field - description description: FieldViolation describes a single validation error for a specific field. CableHealthEvidence: type: object properties: source: type: string description: Evidence source (e.g. "NGA"). summary: type: string description: Human-readable summary of the evidence. ts: type: integer format: int64 description: >- Evidence timestamp, as Unix epoch milliseconds.. Warning: Values > 2^53 may lose precision in JavaScript description: >- CableHealthEvidence represents a single piece of evidence supporting a health assessment. securitySchemes: WorldMonitorKey: type: apiKey in: header name: X-WorldMonitor-Key description: User-issued WorldMonitor API key. ApiKeyHeader: type: apiKey in: header name: X-Api-Key description: Alias header for the WorldMonitor API key (X-WorldMonitor-Key). ````