Sign in
External Services

Run a health check for one service right now

Changed on

Triggers the same engine-specific probe as the background monitor, writes a history row, updates the denormalized fields on external_services, and fires alerts on the Nth consecutive failure (so consecutive-failure state stays honest). Returns the fresh snapshot the UI can display immediately.

post/external-services/{id}/health-check

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-check
  • Auth: none declared

Path parameters

idinteger required

External service ID

Response

Fresh health snapshot after probing

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