Step 1. Ensure that you have the API feature included in your license.

Open “Settings”, check your “License” section. “API” should be present in the list of features.

If you do not have API included, please contact our support team.

Step 2. Enable API in a profile.

Open “Settings”, “Profiles” and pick a profile you are going to deploy to Agents that will have API active. Edit the profile and set the “Enable API” value to “Yes”, then save the changed profile.

The changes will be distributed to all Agents sharing the profile. Agents will open additional 8888 port bound to loopback interface and listen for incoming requests.

The changes will be distributed to all Agents sharing the profile. Agents will open additional 8888 port bound to loopback interface and listen for incoming requests.

Step 3. Make sample requests.

We recommend using the “curl” utility to test the API (or any other tool capable of creating custom HTTP requests).

In this sample, we’ll get an authentication token which is necessary for all non-GET methods and set custom device name, which will immediately be visible on your Connect Management Console.

Note that Agents use cookies to keep track of the sessions, so it is necessary to instruct CURL to save cookies

    curl -c cookie http://localhost:8888/api/v2/token
    {
              "data":
              {
                "token": "1jvbZCTRTn7TssZRNVIuPTJBW0RVJ5_cKeIwtrWUF9E1rSJ9-WCfZsXfjFcAAAAA"
              },
              "method": "GET",
              "path": "/api/v2/token",
              "status": 0
    }
              

Having a token, we can change the device name. The token should be specified as parameter in the URL, the cookie file needs to be supplied and content type should be set to “application/json”

    curl -b cookie -X POST
    http://127.0.0.1:8888/api/v2/client/settings?token=1jvbZCTRTn7TssZRNVIuPTJBW0RVJ5_cKeIwtrWUF9E1rSJ9-WCfZsXfjFcAAAAA -H
    "Content-Type:application/json" -d '{"devicename":"Sample Device"}'
    {
              "data":
              {
                  "autostart": false,
                  "check_update": false,
                  "debug_logging": true,
                  "debugmode": false,
                  "defaultfolderpath": "/",
                  "devicename": "Sample Device",
                  "display_new_version": true,
                  "dlrate": 0,
                  "foldersstoragepath": "%DOWNLOADS%",
                  "listeningport": 39897,
                  "portmapping": true,
                  "show_copy_key": false,
                  "show_notifications": true,
                  "ulrate": 0
              },
              "method": "PATCH",
              "path": "/api/v2/client/settings",
              "status": 0
    }
              

The Agent reports back with a full pack of updated client settings.


Documentation

Have a question for our sales team? Please fill out the form below and a sales representative will get back to you as quickly as possible.

Thank you for your form submission
error message
error message