Test a connection

Use this endpoint to test connectivity for a specific discovered connection owned by the current tenant.

POST /v1/discovery/connections/{connectionId}/test

Test a connection

cURL

curl --request POST \
  --url https://matcher.sandbox.lerian.net/v1/discovery/connections/{connectionId}/test \
  --header 'Authorization: Bearer <token>'

200

Example

{
  "connectionId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "healthy": true,
  "latencyMs": 42,
  "errorMessage": "<string>"
}

Autorizaciones

Authorization · string · header · requerido

Bearer token authentication (format: "Bearer {token}")

Encabezados

X-Request-Id · string

A unique identifier for tracing the request across services.

Parámetros de ruta

connectionId · string<uuid> · requerido

The unique identifier of the connection. Connection ID (UUID)

Ejemplo:

"3fa85f64-5717-4562-b3fc-2c963f66afa6"

Respuesta

200

application/json

Test result

connectionId · string · requerido

Internal Matcher connection identifier that was tested

Ejemplo:

"3fa85f64-5717-4562-b3fc-2c963f66afa6"

healthy · boolean · requerido

Whether the connectivity test succeeded

latencyMs · integer<int64> · requerido

Round-trip connectivity test latency in milliseconds

Ejemplo:

42

errorMessage · string

Sanitized error message when the test failed; empty on success