Connections: Creating and Managing a Connection

CREATING A CONNECTION

First, make a call to Connection Types in order to find out about available types you can create or alternatively, use the browsable version of the API to display the list.

Then, make an OPTIONS request against the Connection type of your choice to find out about available/mandatory options.

Example: OPTIONS for a Connection with Connection_type "123".

curl -X OPTIONS \
 https://YOUR_STACK.datatap.adverity.com/api/connection-types/123/connections/ \
 -H 'Authorization: Token TOKEN_VALUE' \

Result: The result will give you a list of all relevant options that you will include in your POST request body to create a connection of this type, depending on which type is chosen. 

Example: POST request to create a Connection with Connection Type "123".

curl -X POST \
 https://YOUR_STACK.datatap.adverity.com/api/connection-types/123/connections/ \
 -H 'Authorization: Token TOKEN_VALUE' \
 -H 'Content-Type: application/json' \
 -d '{
 "datatype": "DATATYPE",
 "cron_type": "CRON_TYPE",
 "name": "NAME_OF_STREAM",
 "stack": ORGANIZATION_ID
}'

SEARCH FOR CONNECTIONS

To search for available Connections instead of paging through all possible options, use the following SEARCH request:

curl -X SEARCH \
https://YOUR_STACK.datatap.adverity.com/api/connection-types/?search=CONNECTION_NAME \
 -H 'Authorization: Token TOKEN_VALUE' \

Result (Cropped for one return)

{
    "count": XYZ,
    "next": null,
    "previous": null,
    "results": [
        {
            "id": CONNECTION_ID,
            "name": "CONNECTION_NAME",
            "slug": "CONNECTION_AUTHORIZATION",
            "url": "https://YOUR_STACK.datatap.adverity.com/api/connection-types/CONNECTION_ID/",
            "connections": "https://YOUR_STACK.datatap.adverity.com/api/connection-types/CONNECTION_ID/connections/"
        }
    ]
}

EDITING A CONNECTION

To edit an existing Connection, perform a PATCH request where the elements to be changed must be contained within the body. In the below example, the name is changed to "NEW_NAME". 

curl -X PATCH \
https://YOUR_STACK.datatap.adverity.com/api/connections/CONNECTION_ID/ \
 -H 'Authorization: Token TOKEN_VALUE' \
 -H 'Content-Type: application/json' \
 -d '{"name":"NEW_NAME"}'