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

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

Encabezados

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.

Ejemplo:

"Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."

Parámetros de ruta

id · string<uuid> · requerido

Unique identifier of the connection (UUID format).

Ejemplo:

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

Respuesta

200

application/json

La prueba de conexión se realizó correctamente. Una prueba exitosa siempre devuelve status: "success". Cuando la prueba falla, el endpoint devuelve una respuesta de error en lugar de este cuerpo (consulte las respuestas 400, 404, 429 y 500).

Response object containing the result of a connection test.

status · enum<string> · requerido

Resultado de la prueba de conexión. Este cuerpo solo se devuelve en caso de éxito, por lo que el valor siempre es success. Las pruebas fallidas devuelven una respuesta de error en su lugar.

Opciones disponibles: success

Ejemplo:

"success"

message · string · requerido

A human-readable message describing the test result.

Ejemplo:

"Connection successful"

latencyMs · integer<int64> · requerido

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

Ejemplo:

150