Sign in
External Services

Persisted health status for an external service

Changed on

Returns the latest health probe result recorded by ExternalServiceHealthMonitor, plus recent check history for sparklines and a 24-hour uptime percentage. Safe to poll from the UI every 30s.

get/external-services/{id}/health-status

Request

  • Base URL: /api (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /api/external-services/{id}/health-status
  • Auth: none declared

Path parameters

idinteger required

External service ID

Query parameters

limitinteger

Max number of recent checks (default 50, max 200)

Response

Current health + recent history

consecutive_failuresinteger required

Consecutive failed probes. Alert fires at 3.

last_checked_atstring nullable
last_errorstring nullable
response_time_msinteger nullable
service_idinteger required
statusstring nullable

Current health. null if the service has not been probed yet.

uptime_24h_percentnumber double nullable

Uptime percentage over the last 24 hours (0.0 — 100.0). null when there is not enough history.

Example response

{
  "recent_checks": [
    {
      "checked_at": "2026-04-22T11:30:00Z",
      "status": "operational"
    }
  ],
  "status": "operational"
}

Changes