Skip to content
UltimateTeam.ai Docs

Test a connector connection

POST
/api/v1/custom-connectors/{connector_id}/test
curl --request POST \
  --url https://api.ultimateteam.ai/api/v1/custom-connectors/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/test \
  --header 'X-API-Key: <X-API-Key>'

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

Section titled “Authorizations”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters”
connector_id
required
Connector Id
string format: uuid

Responses

Section titled “ Responses ”

200

Section titled “200”

Successful Response

Media typeapplication/json
TestConnectionResponse

Response from testing a connector connection.

object
latency_ms
required
Latency Ms
integer
response_preview
required
Response Preview
string
status_code
required
Status Code
integer
success
required
Success
boolean
Examplegenerated
{
  "latency_ms": 1,
  "response_preview": "example",
  "status_code": 1,
  "success": true
}

422

Section titled “422”

Validation Error

Media typeapplication/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
ctx
Context
object
input
Input
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
Examplegenerated
{
  "detail": [
    {
      "ctx": {},
      "input": "example",
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example"
    }
  ]
}