Pular para o conteúdo principal
POST
/
v1
/
management
/
connections
/
{id}
/
test
Test a connection
curl --request POST \
  --url https://reporter.sandbox.lerian.net/v1/management/connections/{id}/test
{
  "status": "success",
  "message": "Connection successful",
  "latencyMs": 150
}

Cabeçalhos

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.

Exemplo:

"Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."

Parâmetros de caminho

id
string<uuid>
obrigatório

Unique identifier of the connection (UUID format).

Exemplo:

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

Resposta

The result of the connection test.

Response object containing the result of a connection test.

status
enum<string>
obrigatório

Indicates whether the connection test was successful.

Opções disponíveis:
success,
failure
Exemplo:

"success"

message
string
obrigatório

A human-readable message describing the test result.

Exemplo:

"Connection successful"

latencyMs
integer
obrigatório

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

Exemplo:

150