API Reference
Check Connection Health
Verify that a connection is healthy
POST
Authorizations
Organization API key generated in the OpenInt Console and passed in the authorization
header with format: Bearer {apiKey}
Path Parameters
The id of the connection, starts with conn_
Response
200
application/json
Successful response
The id of the connection, starts with conn_
Connection status: healthy (all well), disconnected (needs reconnection), error (system issue), manual (import connection)
Available options:
healthy
, disconnected
, error
, manual
Error types: refresh_failed and unknown_external_error
Available options:
refresh_failed
, unknown_external_error
Optional expanded error message