Skip to main content
POST
/
v2
/
ConnectorValidateConnectivity
Validate connector connectivity
curl --request POST \
  --url http://localhost:3000/v2/ConnectorValidateConnectivity \
  --header 'Content-Type: application/json' \
  --header 'X-Bunker-Token: <api-key>' \
  --data '
{
  "connectorid": 123,
  "connectortype": "<string>",
  "apikey": "<string>",
  "username": "<string>",
  "dbhost": "<string>",
  "dbport": "<string>",
  "dbname": "<string>",
  "tablename": "<string>",
  "request_metadata": {}
}
'
{
  "status": "ok",
  "connected": true
}

Authorizations

X-Bunker-Token
string
header
required

API token for authentication

Body

application/json
connectorid
integer

ID of the connector

connectortype
string

Type of the connector

apikey
string

API key for the connector

username
string

Username for database connection

dbhost
string

Database host

dbport
string

Database port

dbname
string

Database name

tablename
string

Table name

request_metadata
object

Additional metadata for the request

Response

200 - application/json

Connector connectivity validated successfully

status
string
Example:

"ok"

connected
boolean

Whether the connector is connected