Skip to main content
POST
Test endpoint connection

Authorizations

Authorization
string
header
required

API key authorization. Pass your API key in the Authorization header as a Bearer token. Both new (gsk_*) and legacy (gsk-) API keys are accepted, e.g. Authorization: Bearer gsk_... or Authorization: Bearer gsk-....

Body

application/json
id
string

Optional ID of an existing endpoint connection. When provided, stored connection data is used as base and remaining fields act as overrides.

Example:

"id_123"

url
string

The endpoint URL to test.

Example:

"https://api.example.com"

httpMethod
string

HTTP method (GET, POST, etc.)

authType
string

Authentication type (NONE, BEARER, API_KEY, BASIC)

authToken
string

Authentication token (for BEARER or API_KEY). With an ID, a blank value (null or empty string) keeps the stored token, and the token is dropped when authType changes to NONE or BASIC.

username
string

Username (for BASIC auth)

password
string

Password (for BASIC auth). With an ID, a blank value (null or empty string) keeps the stored password, and the password is dropped when authType changes to NONE, BEARER or API_KEY.

Example:

"securePass123!"

headers
object

Custom headers as key-value pairs. With an ID, a value of "••••••••" (the masked value a read returns) sends the stored value of that header name. Without an ID, or for a header with no stored value, "••••••••" is a 400. A value in the stored ciphertext shape is a 400.

inputTemplate
string

Input template with Jinja2 placeholders

timeout
number

Request timeout in seconds

acknowledgedInsecureHttp
boolean

Required true to test an http:// URL. With an ID, the stored value applies when omitted. It is ignored for an https:// URL.

outputMapping
object

JSONPath expressions applied to a successful response. The result is returned in extractedOutput. It is not read from the stored connection.

Response

Test connection result

success
boolean
statusCode
number
latency
number
response
object

The endpoint response. Each inline file payload that output_files matched is replaced by a placeholder such as <base64, 1.2 MB>. The bytes of a file a run would store are in extractedOutput.output_files. A refused payload is not echoed.

error
string
extractedOutput
object

The output mapping applied to a successful response. Absent when no mapping was sent.

extractionError
string

Why the output mapping could not be applied.