REST API for Session Delivery Manager Release 9.0.1 and newer

Get Device Management Summary Information

get

/{versionId}/inventory/deviceMgmt/devices

Retrieve the summary device information for all devices that the user has privileges to view in Device Manager. The user can filter the query request using the query parameters provided in the request.

Request

Path Parameters
Query Parameters
Back to Top

Response

200 Response

400 Response

The user input is invalid.

401 Response

The session ID is invalid.

404 Response

The object (resource URI, device, and so on) of your input request cannot be found.
Back to Top

Examples

Examples of Accessing the API

See Authenticate for how to acquire a session cookie.

The following example shows how to get device management summary information using curl.

curl -X GET \
    -b sessionid.txt \
    --header "Accept: application/xml" \
    "https://example.com:8443/rest/v1.3/inventory/deviceMgmt/devices"

The following example shows how to get device management summary information using Python.

import requests
from lxml import etree
url = "https://example.com:8443/rest/v1.3/inventory/deviceMgmt/devices"
headers = { "Accept":"application/xml", "Cookie":cookie }
resp = requests.get(url, headers=headers)

Example of the Response Body

The following example shows the contents of the response body in XML.

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<devices>
  <devices>
      <bootstrapState>Activated</bootstrapState>
      <connectivityStatus>true</connectivityStatus>
      <id>ID2</id>
      <ip>10.0.17.186</ip>
      <key>sbc186_10.0.17.186</key>
      <manageable>true</manageable>
      <name>sbc186</name>
      <nfId>ID5</nfId>
      <nfName>Sd186</nfName>
      <parentGroupId>ID5</parentGroupId>
      <platformInfo>
          <platform>NNOSVM</platform>
          <serialNumber>--</serialNumber>
      </platformInfo>
      <softwareInfo>
          <configVersion>59</configVersion>
          <version>SCZ840p6</version>
      </softwareInfo>
  </devices>
</devices>

The following example shows the contents of the response body in JSON.

{
  "devices": [
    {
      "bootstrapState": "Activated",
      "connectivityStatus": false,
      "id": "ID1",
      "ip": "10.4.4.161",
      "key": "sd161_10.4.4.161",
      "manageable": true,
      "name": "sd161",
      "nfId": "ID3",
      "nfName": "sd161",
      "parentGroupId": "ID3",
      "platformInfo": {
          "platform": "4600",
          "serialNumber": "--"
      },
      "softwareInfo": {
          "configVersion": "65",
          "version": "SCZ840"
      }
    }
  ]
}
Back to Top