Sign in

v1

latestOpenAPI 3.1.02026-07-263644911022.4 KB
Discovery

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

Path parameters

connectionIdstring required

The unique identifier of the connection.

Headers

X-Request-Idstring

A unique identifier for tracing the request across services.

Response

Test result

connectionIdstring

Identifier of the connection that was tested

healthyboolean

Whether the connection test succeeded

latencyMsinteger

Round-trip latency in milliseconds

errorMessagestring

Error details when the test failed

Example response

{
  "healthy": true,
  "latencyMs": 42
}