REST Resources
-
/ -
/acknowledge-device-fingerprint -
/change-device-credentials -
/delete-device-discovery-rules -
/delete-devices -
/device-discovery-rules -
/device-discovery-rules /{id} -
/devices -
/devices /{device-id} /activate-modeled-device -
/devices /{device-id} /applicable-configlets -
/devices /{device-id} /apply-cli-configlet -
/devices /{device-id} /associated-softwares -
/devices /{device-id} /clone -
/devices /{device-id} /compute-configlet-parameter-values -
/devices /{device-id} /configlet -
/devices /{device-id} /configurations /expanded -
/devices /{device-id} /configurations /raw -
/devices /{device-id} /submit-cli-configlet -
/devices /{device-id} /validate-cli-configlet -
/devices /{deviceid} /customized-attribute-values -
/devices /{deviceid} /customized-attribute-values /{id} -
/devices /{id} -
/devices /{id} /associated-scripts -
/devices /{id} /change-requests -
/devices /{id} /configurations -
/devices /{id} /configurations /expanded /match-content -
/devices /{id} /configurations /raw /match-content -
/devices /{id} /connection-status -
/devices /{id} /exec-resync -
/devices /{id} /exec-rpc -
/devices /{id} /managed-elements -
/devices /{id} /managed-status -
/devices /{id} /modify-device-target-ip -
/devices /{id} /view-customized-attributes -
/discover-devices -
/discoveryresult /{id} -
/get-device-statistics -
/get-syslog-events -
/job-instances /{job-id} /acknowledge-fingerprint-job-results -
/job-instances /{job-id} /delete-devices-job-results -
/job-instances /{job-id} /discovery-job-results -
/job-instances /{job-id} /exec-rpc-job-results -
/job-instances /{job-id} /reboot-devices-job-results -
/job-instances /{job-id} /resync-devices-job-results -
/job-instances /{job-id} /rsa-key-transfer-job-results -
/reactivate-devices-from-rma -
/reboot-devices -
/resolve-key-conflict -
/resync-devices -
/stop-syslog-events -
/stop-syslog-events /{id} -
/upload-keys
/api/space/device-management/devices
The following operations are supported on this resource:
GET /devices | Version 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
- OSversion
- deviceFamily
- SerialNumber
- platform
- managedStatus
- connectionStatus
- attribute-column-0
Sorting is supported on the following fields:
- name
- OSversion
- deviceFamily
- SerialNumber
- platform
- ipAddr
- managedStatus
- connectionStatus
- attribute-column-0
Sample Usage
GET /devices
-
Accept Headers:
application/vnd.net.juniper.space.device-management.devices+xml;version=2
application/vnd.net.juniper.space.device-management.devices+json;version=2
<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>
<device-id>229379</device-id>
<lsys-count>0</lsys-count>
<hosting-deviceId>0</hosting-deviceId>
<authentication-status>CREDENTIAL</authentication-status>
<connection-type>Junos Space initiated</connection-type>
<name>hsc-srx_200</name>
<domain-id>32769</domain-id>
<domain-name>GLOBAL</domain-name>
<config-status>DEVICE_STATE_IN_SYNC</config-status>
</device>
</devices>
{
"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",
"device-id": 229379,
"lsys-count": 0,
"hosting-deviceId": 0,
"authentication-status": "CREDENTIAL",
"connection-type": "Junos Space initiated",
"name":"hsc-srx_200",
"domain-id": 32769,
"domain-name": "Global",
"config-status": "DEVICE_STATE_IN_SYNC",
}
}
Access Control
The following capabilities are required to access this API: ReadDevices
For the deprecated versions of this API, refer to :
version 1
POST /devices | Version 3 |
Get Device(s) by given Device Id list.
Sample Usage
POST /devices
-
Content-Type Headers:
application/vnd.net.juniper.space.device-management.device-by-ids-request+xml;version=3;charset=UTF-8
application/vnd.net.juniper.space.device-management.device-by-ids-request+json;version=3;charset=UTF-8 -
Accept Headers:
application/vnd.net.juniper.space.device-management.device-by-ids+xml;version=3
application/vnd.net.juniper.space.device-management.device-by-ids+json;version=3
<device-by-ids-request>
<device-ids>
<device-id>557070</device-id>
</device-ids>
</device-by-ids-request>
<device-by-ids total="1" uri="/api/space/device-management/devices">
<device
href="/api/space/managed-domain/devices-require-polling/2228251" uri="/api/space/device-management/devices/2228251">
<OSVersion>14.1X53-D40.8</OSVersion>
<status>down</status>
<lsys-count>0</lsys-count>
<dev-admin>root</dev-admin>
<software-release>14.1X53-D40.8</software-release>
<discovery-ip>1.1.1.1</discovery-ip>
<hosting-deviceId>0</hosting-deviceId>
<device-connection-type>APPINIT</device-connection-type>
<newFingerprint>ef:34:98:e6:fa:ff:fd:6e:d8:d9:09:75:8a:62:ef:3e</newFingerprint>
<virtual-chassis-status>true</virtual-chassis-status>
<fingerprint>15:88:53:a6:b1:97:85:68:4c:11:9d:b8:2a:8a:0f:b7</fingerprint>
<ipAddr>192.168.27.72</ipAddr>
<vendor>Juniper Networks</vendor>
<device-uuid>
<category>category-name</category>
<service>service-name</service>
<row-id>1234565</row-id>
</device-uuid>
<adapter-name>WWADAPTER</adapter-name>
<device-type>LSYS</device-type>
<device-ip>192.168.27.72</device-ip>
<authentication-status>CREDENTIAL</authentication-status>
<original-platform>EX4200-24T</original-platform>
<platform>EX4200-24T</platform>
<dev-admin-passwd>********</dev-admin-passwd>
<staged-status-from-view>NOTSTAGED</staged-status-from-view>
<domain-id>32769</domain-id>
<logical-interfaces>View</logical-interfaces>
<matching-schema>13.2X50-D15.3</matching-schema>
<id>2228251</id>
<name>Ex_device</name>
<staged-status>NOTSTAGED</staged-status>
<display-name>Ex_device</display-name>
<domain-name>Global</domain-name>
<device-family>junos-ex</device-family>
<config-status>DEVICE_STATE_AWAIT_1STCONNIM</config-status>
</device>
</device-by-ids>
{
"device-by-ids-request": {
"device-ids": {
"device-id": "557070"
}
}
}
{
"device-by-ids" : {
"@total" : "1" ,
"@uri" : "/api/space/device-management/devices" ,
"device" : {
"@href" : "/api/space/managed-domain/devices-require-polling/2228251" ,
"@uri" : "/api/space/device-management/devices/2228251" ,
"OSVersion" : "14.1X53-D40.8" ,
"status" : "down" ,
"lsys-count" : 0 ,
"dev-admin" : "root" ,
"software-release" : "14.1X53-D40.8" ,
"discovery-ip" : "1.1.1.1" ,
"hosting-deviceId" : 0 ,
"device-connection-type" : "APPINIT" ,
"newFingerprint" : "ef:34:98:e6:fa:ff:fd:6e:d8:d9:09:75:8a:62:ef:3e" ,
"virtual-chassis-status" : true,
"fingerprint" : "15:88:53:a6:b1:97:85:68:4c:11:9d:b8:2a:8a:0f:b7" ,
"ipAddr" : "192.168.27.72" ,
"vendor" : "Juniper Networks" ,
"device-uuid" : {
"category" : "category-name" ,
"service" : "service-name" ,
"row-id" : 1234565
} ,
"adapter-name" : "String" ,
"device-type" : "String" ,
"device-ip" : "192.168.27.72" ,
"authentication-status" : "CREDENTIAL" ,
"original-platform" : "EX4200-24T" ,
"platform" : "EX4200-24T" ,
"dev-admin-passwd" : "********" ,
"staged-status-from-view" : "NOTSTAGED" ,
"domain-id" : 0 ,
"logical-interfaces" : "View" ,
"matching-schema" : "13.2X50-D15.3" ,
"id" : 2228251 ,
"name" : "Ex_device" ,
"staged-status" : "NOTSTAGED" ,
"display-name" : "Ex_device" ,
"domain-name" : "Global" ,
"device-family" : "junos-ex" ,
"config-status" : "DEVICE_STATE_AWAIT_1STCONNIM"
}
}
}
Access Control
The following capabilities are required to access this API: ReadDevices