Run a connection test for the specified connection.

For more information on connections, see Connection Types.

Version:  v4

Required Permissions

Request

Request Type: GET

Endpoint:

/v4/connections/<id>/status

where:

ParameterDescription
<id>Internal identifier for the connection

Request URI - Example:

/v4/connections/10/status

Request Body:

Empty.

Response

Response Status Code - Success:  200 - OK

Response Body Example:

{
  "result": "SUCCESS",
  "reason": null
}

Reference

PropertyDescription
result

Results of testing the connection.

reasonIf the result value is not SUCCESS, additional information may be included here.