POST
/
v1
/
http
/
test-connection
{
  "success": true,
  "status": 123,
  "response_time": 123,
  "content_type": "<string>",
  "size": 123,
  "data": {},
  "400 Bad Request": {},
  "500 Internal Server Error": {}
}

​
Test HTTP Connection

This endpoint allows you to test a connection to an external API by sending a request and receiving the response without creating any persistent resources. Use this before creating a permanent connection to validate that your configuration works.

​
Request Body

​
url
string
required

The URL of the API endpoint to test

​
method
string
required

The HTTP method to use (GET, POST, PUT, DELETE, PATCH, HEAD, OPTIONS)

​
headers
object

HTTP headers to include with the request

​
parameters
object

Query parameters with values and required flags

​
parameterGroups
array

Groups of related parameters that should be treated as mutually exclusive

​
authType
string

Authentication type (None, API Key, Bearer Token, Basic Auth)

​
auth
object

Authentication details based on the auth type specified

​
body
object

Request body configuration for POST, PUT, PATCH requests

​
responsePathExtractor
string

JSON path to extract a specific key from the response to use as the main data source. For example, “value” will extract data from the “value” field of the response.

​
Response

​
success
boolean

Whether the connection was successful

​
status
integer

HTTP status code of the response

​
response_time
integer

Time taken for the request in milliseconds

​
content_type
string

Content type of the response

​
size
integer

Size of the response in bytes

​
data
object

The response data (parsed JSON or text)

​
Request Example

{
  "url": "https://api.weather.com/v3/location/search",
  "method": "GET",
  "parameters": {
    "query": {
      "value": "London",
      "required": true
    },
    "apiKey": {
      "value": "abcdef123456",
      "required": true
    }
  },
  "parameterGroups": [],
  "authType": "None",
  "auth": {},
  "responsePathExtractor": "value"
}

​
Response Example

{
  "success": true,
  "status": 200,
  "response_time": 324,
  "content_type": "application/json",
  "size": 1568,
  "data": {
    "location": {
      "city": "London",
      "country": "United Kingdom",
      "lat": 51.5074,
      "lon": -0.1278
    },
    "matches": [
      {
        "name": "London",
        "country": "United Kingdom"
      },
      {
        "name": "London",
        "country": "Canada"
      }
    ]
  }
}

​
Error Responses

​
400 Bad Request
object

Returned when the request is malformed or invalid

​
500 Internal Server Error
object

Returned when there’s a server error

​
Notes

  • The HTTP request is executed directly, and no resources are persisted
  • Response data for binary content is represented as a placeholder
  • For testing authenticated APIs, include the appropriate authentication details
  • Use the responsePathExtractor parameter when your API response contains a specific key that holds the main data you want to work with. For example, if your API returns a JSON with a value field containing stringified JSON data, setting responsePathExtractor to “value” will extract and use that data as the main source for query generation.