Skip to main content
GET
/
connectors
/
{connector_id}
/
health
Get health for a specific connector
curl --request GET \
  --url https://{hostname}/v1/connectors/{connector_id}/health \
  --header 'Authorization: Bearer <token>'
{
  "id": "connector_001",
  "status": "reachable",
  "checked_at": "2026-02-19T14:23:00Z",
  "latency_ms": 142,
  "error": null
}

Authorizations

​
Authorization
string
header
required

JWT issued by your organization's SAML/OIDC identity provider after authentication. Required for user-attributed queries. The sub claim is recorded verbatim in the audit trail.

Path Parameters

​
connector_id
string
required

The connector identifier, as returned by GET /connectors.

Response

Connector health returned.

​
id
string
required
Example:

"connector_001"

​
status
enum<string>
required
  • reachable: connector is responding normally
  • unreachable: connector cannot be reached (egress blocked or service down)
  • degraded: connector is responding but with elevated latency or partial errors
  • unknown: health has not been checked recently
Available options:
reachable,
unreachable,
degraded,
unknown
​
checked_at
string<date-time>
required
Example:

"2026-02-19T14:23:00Z"

​
latency_ms
integer | null
Example:

142

​
error
string | null

Error message if the connector is not reachable.

Example:

null