The CleverFox Backup API allows you to interact with our system programmatically from your own application. Using the API you interact with Resources such as:

• Companies
• Devices
• Jobs
• Logs

The API attempts to conform to the RESTful design principles. You interact with the resources exposed via the API by accessing resource collection and element URIs using the HTTP verbs (GET, POST, PUT, and DELETE). CleverFox Backup accepts and returns JSON data via the API.

Requirements

The CleverFox Backup API requires a Partner Plan. Partnership opportunities are available for Vertical Market Application and Custom Application developers. Contact us for details.

Authentication

Authentication is implemented as HTTP Basic Authentication over TLS >= 1.2 (HTTPS), as described in the API Authentication.

URL

The URL for API requests is:

https://cleverfoxbackup.com/api/{resource}

Resources

The available resources are listed in the API Resources.

Response Data

Response data is sent as JSON.

Response codes are sent via the normal HTTP Response Code, and are documented separately for each resource.

For boolean fields, please note that a value of null should be considered the same as false.

Request Data

POST and PUT request data must be formatted as JSON (application/json). For best results, you should set your HTTP Content-Type request header accordingly.

Note that CleverFox Backup does not accept PUT or POST data sent as query params or form encoded data. If you fail to set your Content-Type to application/json, your request may fail due to triggering of forgery protection mechanisms.

Debugging

If you’re having difficulty executing a request via our API, try the simplest thing and attempt your request via the Google Chrome add-on tool Postman.

If you are unable to connect at all, check that you are using TLS 1.2 or better, and review the information in the API Authentication Troubleshooting section.

Backwards Compatibility

We consider the following changes to be backwards compatible and may make them without advance notice:

• Adding new API endpoints, or adding new attributes to existing endpoints.
• Adding new optional parameters to existing API endpoints.

In addition, you should not depend on the order of attributes within the API response as this may change.