REST API Usage Guide

Welcome to the Appliance REST API Guide. This is the API for managing the appliance via curl or other web based calls. The examples in this documentation are generic. To use these API commands via curl use the following command prefix:

External Request

Calling the API from outside the appliance.

curl -i -k -X HTTP_METHOD -u USER:PASSWORD https://C_INTERFACE_IP/API_CALL

Container Request

Containers have a secret key that can be used for authentication.

curl -i -X HTTP_METHOD -u `cat /opt/appliance/api/api_key.txt`:NONE http://169.254.254.130/API_CALL

Sending JSON

Some API calls require sending JSON data. This requires added options to the curl commands.

-H "Content-Type: application/json" ... -d '{"key": "value"}'