POST
/
connection
/
{id}
/
check
import Openint from '@openint/sdk';

const client = new Openint({
  apiKey: process.env['OPENINT_API_KEY'], // This is the default and can be omitted
});

async function main() {
  const response = await client.checkConnection('conn_');

  console.log(response.id);
}

main();
{
  "id": "<string>",
  "status": "healthy",
  "error": "refresh_failed",
  "errorMessage": "<string>"
}

Authorizations

​
Authorization
string
header
required

Organization API key generated in the OpenInt Console and passed in the authorization header with format: Bearer {apiKey}

Path Parameters

​
id
string
required

The id of the connection, starts with conn_

Response

200
application/json
Successful response
​
id
string
required

The id of the connection, starts with conn_

​
status
enum<string>
required

Connection status: healthy (all well), disconnected (needs reconnection), error (system issue), manual (import connection)

Available options:
healthy,
disconnected,
error,
manual
​
error
enum<string>

Error types: refresh_failed and unknown_external_error

Available options:
refresh_failed,
unknown_external_error
​
errorMessage
string

Optional expanded error message