Skip to main content

Test a Private Connection by ID

Test a saved private connection. This API requires data source module permissions.

Endpoint: /openapi/v1/tunnel/testById

Method: GET

Request parameters

ParameterTypeRequiredDescription
tunnelIdStringYesPrivate connection ID.

Response parameters

data contains Boolean success, connection status, and errorMessage when the test fails.

Success response

{"success": true, "requestId": "<requestId>", "data": {"success": true, "status": "normal", "errorMessage": null}}