Test a Connection
post
/ic/api/integration/v1/connections/{id}/test
Tests a connection by doing a ping test. Can be used to check the status of the connection.
Request
Path Parameters
-
id(required): string
Connection identifier
Query Parameters
-
integrationInstance(required): string
This is the name of the service instance. You can get this value from the About page where it is specified in the Service instance field.
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json; charset=utf-8
200 Response
Successful operation
404 Response
Connection not found
409 Response
Connection is not configured
412 Response
Connection is locked
500 Response
Server error
Examples
The following example shows how to test the connection by submitting a POST request on the REST resource using cURL. For more information about cURL, see Use cURL. For more information about endpoint URL structure, see Send Requests.
Example: Check connection status
This command sends a test request to the specified connection. Use this command to check the status of the connection. If the test returns HTTP 200, the connection is CONFIGURED.
curl -X POST -H 'Authorization: Bearer access_token' -H "Accept:application/json" https://design.integration.region.ocp.oraclecloud.com/ic/api/integration/v1/connections/REST_SAMPLE/test?integrationInstance=service-instance