Test a connection

Use this endpoint to test the configured connection by establishing and closing a connection to the database. Returns the connection status, latency, and database name.

POST /v1/management/connections/{id}/test

Test a connection

cURL

curl --request POST \
  --url https://reporter.sandbox.lerian.net/v1/management/connections/{id}/test

200

Success

{
  "status": "success",
  "message": "Connection successful",
  "latencyMs": 150
}

Headers

Authorization · string

The authorization token in the Bearer <token> format.

Important: This header is required if your environment has Access Manager enabled. For more information, refer to the Access Manager documentation.

Example:

"Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."

Path Parameters

id · string<uuid> · required

Unique identifier of the connection (UUID format).

Example:

"019996b8-f3d1-7d2b-a192-6e91464d82fc"

Response

200

application/json

The result of the connection test.

Response object containing the result of a connection test.

status · enum<string> · required

Indicates whether the connection test was successful.

Available options: success, failure

Example:

"success"

message · string · required

A human-readable message describing the test result.

Example:

"Connection successful"

latencyMs · integer · required

The time taken to establish the connection, measured in milliseconds.

Example:

150