REST response structure

The appliance returns responses to REST management interface requests.

When you send a REST request, the appliance responds with a structured response in JSON format. The exact structure of the response depends on the resource and URI of the request, but all responses are similar.

The response includes all available resources from any point within the API. It includes the resources by embedding a _links element within the JSON response, which contains pointers to accessible resources, including possible documentation. You can then target the resources within the _links element in your subsequent REST management interface requests.

For example, when you specify a GET request for the REST API root (https://example.com:5554/mgmt/), the response consists of the resources available that is structured as a list of fields and values:

{
   "_links": {
      "self": {
      "href": "/mgmt/"
   },
   "config": {
      "href": "/mgmt/config/"
   },
   "domains": {
      "href": "/mgmt/domains/config/"
   },
   "status": {
      "href": "/mgmt/status/"
   },
   "actionqueue": {
      "href": "/mgmt/actionqueue/"
   },
   "filestore": {
      "href": "/mgmt/filestore/"
   },
   "metadata": {
      "href": "/mgmt/metadata/"
   },
   "types": {
      "href": "/mgmt/types/"
      }
   }
}

The following example shows the response to a request for status information about the current firmware version of the appliance, GET '/mgmt/status/default/FirmwareVersion':

{  
  "_links": {
    "self": {
      "href": "/mgmt/status/default/FirmwareVersion"
    },
    "doc": {
      "href": "/mgmt/docs/status/FirmwareVersion"
    }
  },
  "FirmwareVersion": {
    "Serial": xxxxxxx,
    "Version": "MQ00.9.0.1.0",
    "Build": "xxxxxxx",
    "BuildDate": "2016/09/20 10:29:27",
    "WatchdogBuild": "MQ00.9.0.1.0",
    "InstalledDPOS": "MQ00.9.0.1.0",
    "RunningDPOS": "MQ00.9.0.1.0",
    "XMLAccelerator": "embedded",
    "MachineType": 5725,
    "ModelType": "S14"
  }
}