Connections

Get connections

Retrieves a list of connections.

SecurityApiKeyAuth
Responses
200

OK

get/result/list
Request samples 
Response samples 
application/json
{
  • "results": [
    ]
}
Create connection
Creates a connection.


SecurityApiKeyAuth 
Request 
path Parameters
connection_name
required
string
the connection name


 
Request Body schema: application/x-www-form-urlencoded
url
string
 
Responses 
200
OK


post/result/create/{connection_name}
Request samples 
application/x-www-form-urlencoded
url=string
Response samples 
application/json
{
  • "name": "string",
  • "result": "string"
}
Delete connection
Deletes a connection.


SecurityApiKeyAuth 
Request 
path Parameters
connection_name
required
string
the connection name


 
Responses 
200
OK


post/result/delete/{connection_name}
Request samples 
Response samples 
application/json
{
  • "name": "string",
  • "result": "string"
}
Get connection id by name
Retrieves the specified connection.


SecurityApiKeyAuth 
Request 
query Parameters
name
required
string
 
Responses 
200
OK


get/connections/lookup
Request samples 
Response samples 
application/json
{
  • "id": 17
}
Validate connector config
Validates a connector configuration.


SecurityApiKeyAuth 
Request 
Request Body schema: application/x-www-form-urlencoded
type
string
 
settings
object
 
connection_id
integer (ConnectionId) 
the connection id


 
Responses 
200
OK


post/connector_configs/validate_with_connection
Request samples 
application/x-www-form-urlencoded
type=string&&connection_id=17
Response samples 
application/json
{
  • "type": "string",
  • "settings": { }
}