Skip to content

Test a connector connection

POST
/api/v1/custom-connectors/{connector_id}/test

Test connectivity to the configured API endpoint.

Sends a real HTTP request with authentication headers and returns the result with a response preview.

Args: connector_id: The connector UUID.

Returns: Test result with success, status code, preview, latency.

Authorizations

Parameters

Path Parameters

connector_id
required
string format: uuid

Responses

200

Successful Response

Response from testing a connector connection.

object
latency_ms
required
integer
response_preview
required
string
status_code
required
integer
success
required
boolean

422

Validation Error

object
detail
Array<object>
object
ctx
object
input
loc
required
Array
msg
required
string
type
required
string