/
/OpenInt API
DocsSign in
Sign in
  • APIs
  • Generators
  • Stacks
  • Projects
  • Docs
  • History
  • Schema
Checked 2h ago · Updated 11mo ago
  • getList Connectors
  • get/v1/connector-config/{id}
  • put/v1/connector-config/{id}
  • delete/v1/connector-config/{id}
  • getList Configured Connectors
  • post/v1/connector-config
  • getGet Connection
  • deleteDelete Connection
  • getList Connections
  • postCreate Connection
  • postCreate Customer Authentication Token
  • post/v1/connect/pre-connect
  • post/v1/connect/post-connect
  • postCheck Connection Health
  • getList Organization Events
  • getList Customers
  • putUpsert Customer
  • getHealth Check
  • post/v1/health
  • get/v1/connector-status
  • getGet Current User
  • post/v1/webhook/{connector_name}
  • getGet Message Template
  • getGet Connection
  • deleteDelete Connection
  • getList Connections
  • postCreate Connection
  • putAssign Connection
  • deleteDelete Connection Assignment
  • getList Connection Assignments
  • get/v2/connector-config/{id}
  • put/v2/connector-config/{id}
  • delete/v2/connector-config/{id}
  • getList Configured Connectors
  • post/v2/connector-config
  • post/v2/connector-config/pre-configure
  • postExecute RPC function on connector
  • getList Connectors
  • postSend Email
  • getGet Rate Limit Status
  • putUpsert Organization

Check Connection Health

Verify that a connection is healthy

post/v1/connection/{id}/check

Path parameters

idstring required

The id of the connection, starts with conn_

The id of the connection, starts with conn_

Response

Successful response

idstring required
status'healthy' | 'disconnected' | 'error' | 'manual' | 'unknown' | 'null' nullable
status_messagestring nullable

Changes