REST Resources

/api/space/device-management/devices

The following operation is supported on this resource:

GET /devicesVersion 2

This API retrieves all devices. It returns device attributes along with a link to individual device information. It supports filtering, sorting, and paging.

Note: Filtering on the 'ipAddr', 'managedStatus' and 'connectionStatus' field works ONLY for the 'eq' operation. For example, filter=(ipAddr eq '192.168.21.9').

Filtering is supported on the following fields:

  • name
  • softwareRelease or OSversion
  • deviceFamily
  • SerialNumber
  • platform
  • managedStatus
  • connectionStatus

Sorting is supported on the following fields:

  • name
  • softwareRelease or OSversion
  • deviceFamily
  • SerialNumber
  • platform
  • ipAddr
  • managedStatus
  • connectionStatus
.

Sample Usage

GET /devices


  • Sample Output XML:

    <devices size="1" uri="/api/space/device-management/devices">
     <device key="229379" uri="/api/space/device-management/devices/229379"
     href="/api/space/device-management/devices/229379">
      <deviceFamily>junos-es</deviceFamily>
      <OSVersion>10.3R2.11</OSVersion>
      <platform>SRX100B</platform>
      <serialNumber>AT5109AF0621</serialNumber>
      <connectionStatus>up</connectionStatus>
      <ipAddr>192.168.21.9</ipAddr>
      <managedStatus>In Sync</managedStatus>
      <name>hsc-srx_200</name>
     </device>
    </devices>

  • Sample Output JSON:

    {
     "devices":{
      "@size":"1",
      "@uri":"/api/space/device-management/devices",
      "device":{
         "@key":"229379",
         "@uri":"/api/space/device-management/devices/229379",
         "@href":"/api/space/device-management/devices/229379" ,
         "deviceFamily":"junos-es",
         "OSVersion":"10.3R2.11",
         "platform":"SRX100B",
         "serialNumber":"AT5109AF0621",
         "connectionStatus":"up",
         "ipAddr":"192.168.21.9",
         "managedStatus":"In Sync",
         "name":"hsc-srx_200"
      }
     }

    • Access Control

    The following capabilities are required to access this API: ReadDevices

      For the deprecated versions of this API, refer to :
    • version 1