Skip to main content
GET
Returns whether a connector is working: an overall status for the connector plus one health entry per configured resource. A connector that syncs four tables and fails on a fifth reports degraded instead of looking healthy.

Reading the response

status is the overall health. It is the worst of the credential state and every resource’s state:
  • healthy: every resource synced and nothing needs attention.
  • degraded: the connector is still scheduled but not fully working. At least one resource is failing, the latest sync failed and is being retried, synced sources are failing to index, or no resources are configured. Check resources[].message, or error when the whole sync failed.
  • failed: only you can fix it, for example by reconnecting after the provider rejected the credentials, or after a sync failure that will not clear on retry. error.action says what to do.
  • checking: resources were just configured and HydraDB is still testing access to them.
  • paused: the connector is paused. Resume Connector resumes scheduled syncs.
  • capped: a plan limit is pausing syncs. plan_cap says which limit.
lifecycle and sync_status answer a different question: what the connector is doing right now. A connector can be syncing and degraded at the same time. For each resource, status is the result of its last sync. When a resource fails, retryable: false means the provider rejected it and waiting will not help. To see whether the connector as a whole has stopped syncing, read sync_blocked and sync_blocked_reason on Get Connector.
acl_warning on a resource means HydraDB could not read that resource’s ACL from the provider. If you set an ACL on the resource, yours still applies. If you did not, its sources are readable by everyone until the next successful read. Set one with Update Connector Resource to restrict it in the meantime.page_acl_warning means restrictions on some individual pages, for example in Confluence, could not be read, so those pages are readable by everyone until a later sync reads them. See Query.

Authorizations

Authorization
string
header
required

Send your API key as Authorization: Bearer <your_api_key>.

Path Parameters

id
string
required

Connector ID

Example:

"HydraDoc1234"

Response

OK

connector_id
string

Connector this resource belongs to.

Example:

"conn_abc123"

error
HandlerConnectorStatusError · object | null

Connector-level failure, such as rejected credentials or a failed sync. null when the connector itself is fine; resource problems are reported on each resource.

Example:

null

last_attempted_sync_at
string

RFC3339 timestamp of the most recent sync attempt (successful or not).

Example:

"2026-07-02T17:00:00Z"

last_successful_sync_at
string

RFC3339 timestamp of the last successful sync completion.

Example:

"2026-07-02T17:00:00Z"

lifecycle
string

What the connector is doing now: reconnect, syncing, pending_setup, ingesting or active. Independent of status.

next_sync_at
string

RFC3339 timestamp when the next scheduled sync will run.

Example:

"2026-07-02T18:00:00Z"

plan_cap
HandlerPlanCapView · object

The plan limit that is currently stopping syncs.

Example:
provider
string

External provider being synced (e.g. slack, github, linear, notion, gmail).

Example:

"slack"

resources
HandlerConnectorResourceStatus · object[]

One entry per configured resource with its own health. Always an array, empty when no resources are configured.

Example:
status
string

Overall health: healthy, degraded (partly failing, still retrying), failed (you must act: reconnect or recreate a deleted database), checking, paused, or capped.

Example:

"healthy"

sync_status
string

syncing while a sync is running, otherwise idle. Independent of status: a connector can be syncing and degraded at once.

Example:

"idle"