Skip to main content
POST
/
api
/
v1
/
connector_definitions
/
check_connection
Checks the connection for a specified connector definition
curl --request POST \
  --url https://api.squared.ai/api/v1/connector_definitions/check_connection \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "type": "source",
  "name": "<string>",
  "connection_spec": {}
}
'
{
  "result": "success",
  "details": "<string>"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
​
type
enum<string>
Available options:
source,
destination
​
name
string
​
connection_spec
object

Generic connection specification structure. Specifics depend on the connector type.

Response

200 - application/json

Connection check successful

​
result
enum<string>
Available options:
success,
failure
​
details
string