Test Connection

Tests the specified existing connection to verify it can connect.

POST /connections/{connection_type}/{connection_id}/test

Test Connection

cURL

curl --request POST \
  --url https://api.xplenty.com/{account_id}/api/connections/{connection_type}/{connection_id}/test \
  --header 'Accept: <accept>' \
  --header 'Authorization: Basic <encoded-value>'

200

{
  "message": "<string>"
}

Authorizations

Authorization · string · header · required

Enter your API key as the username. Leave the password field blank. Example: curl -u YOUR_API_KEY: https://api.xplenty.com/...

Headers

Accept · string · default: application/vnd.xplenty+json; version=2 · required

API version header — required on all requests

Path Parameters

connection_type · string · required

The type of the connection (e.g., sftp, mysql, salesforce).

connection_id · integer · required

The numeric ID of the connection to test.

Response

200 - application/vnd.xplenty+json; version=2

Connection test result

status · enum<string>

Available options: success, failure

message · string