Skip to main content
POST
Test a connection

Authorizations

Authorization
string
header
required

a valid bearer token

Path Parameters

projectId
string
required

The project ID

Pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

Query Parameters

environmentName
string
required

The name of the environment to test in

Minimum string length: 1
connectionName
string
required

The name of the connection to test

Minimum string length: 1

Response

Connection test completed

message
string | null

A message describing the failure reason, absent on success.

Example:

"Authentication failed: invalid credentials"

status
string

The result of the connection test.

Example:

"SUCCESS"