https://{applianceaddress}/

In working with the Unitrends RESTful APIs, clients must first be authenticated to the appliance. This is accomplished by providing the username and password of a valid system user. The authentication token returned must then be passed in for every subsequent API call. Details of the authentication API are here.

There is a standard set of URL parameters supported for filtering of API results. For example, if a system ID is not specified, APIs will return aggregate results for all of the managed systems this user can see. Each object will include an "sid" key with the value the value of the system on which the results are associated. However, if a system filter is specified in the request, the API will return results for only that specified system and no "sid" key is included in the results.

Each request will return an HTTP status code of 200 or 201 on success or an error status on failure. If an error is returned, the message to be displayed will be returned in a corresponding JSON "result" array that contains one or more additional details.

There are over 70 HTTP status codes, but the REST APIs will use only eight of them. These are defined here.

PUT, POST, and DELETE APIs modify, add, or delete a system object. They return a result to indicate whether or not the operation were successful, and messages to display on error or warning. In addition, depending on the object created, additional information, such as the id of the created object, will be returned. The return codes are more deatileda bout the failure (codes to be implemented) and may also include a link for more information (to be implemented).

GET APIs return data to the caller. If an API fails, the HTTP status code will indicate the failure type, and a result object will be returned with the code and any message(s) to be displayed to the user.

Error, with 2 messages for the user.

HTTP Status: 500 (Internal Server Error)

Result Object:

{
   "result": [
       {
           "code": 1345,
           "message":  "The license could not be updated.",
           "link": "http://kb.unitrends.com/342"
       },
       {
           "message":  "The format of the license string is invalid."
       },
   ]
}

Successful creation of a schedule job, and the id of the new schedule is 234:

HTTP Status: 201 (Created)

Result Object:

{
   "result": [
       {
           "id": 234
       }
   ]
}

The operation succeeded, but with warnings:

HTTP Status: 200 (OK)

Result Object:

{
   "result": [
       {
           "code": 43584,
           "message": "The operation succeeded, but you need to be aware of this.",
           "link": "http://kb.unitrends.com/45"
       }
   ]
}