Get health status summary for all monitored carrier APIs

Returns comprehensive health data including: - Overall statistics (total carriers, operations, status counts) - Detailed health snapshots for each carrier API operation

This endpoint provides real-time health status from Redis monitoring data.

SecurityAPIKeyHeader

Responses

200

Successful Response

Response Schema: application/json

total_carriers required	integer (Total Carriers) Total number of unique carriers monitored
total_operations required	integer (Total Operations) Total number of carrier operations monitored
healthy_operations required	integer (Healthy Operations) Number of operations with UP status
degraded_operations required	integer (Degraded Operations) Number of operations with DEGRADED status
down_operations required	integer (Down Operations) Number of operations with DOWN status
required	Array of objects (Carriers) List of all carrier health snapshots

404

The resource requested was not found either because you do not have permissions to access it or it does not exist.

500

An unknown internal server issue occured while processing a request. A report is created and logged.

get/carrier-connections/health

Request samples

curl
Node.js
JavaScript
Python
Java

Response samples

application/json

{"total_carriers": 0,
"total_operations": 0,
"healthy_operations": 0,
"degraded_operations": 0,
"down_operations": 0,
"carriers": [{"carrier_code": "string",
"operation": "string",
"version": "string",
"status": "UP",
"failure_count": 0,
"request_count": 0,
"failure_rate": 0,
"avg_response_time": 0,
"last_failure_time": "string",
"last_success_time": "string"
}
]
}