devices
For all the device GET APIs, the responses returned by the API corresponds to the device state at the last device check-in.
HTTP Method
GET
Request URI
https://<hostname>/api/apigatewaydataservices/v1/devices
Header Parameters
| Name | Type | Description |
|---|---|---|
|
Authorization |
String |
Use the Bearer <access-token> value determined during the Authentication process. |
Example Response
{
"@odata.count": 526,
"value": [
{
"DisplayName": "MJW11AG2SU4",
"DiscoveryId": "AYk_dW1-0weDRYMasUNP",
"DeviceName": "MJW11AG2SU4",
"Network": {
"TCPIP": {
"Address": "10.39.248.116"
}
},
"OS": {
"Version": "Windows 11",
"Name": "Windows 11"
},
"System": {
"Model": "VMware7,1"
}
},
{
"DisplayName": "MJW10EPMAGSU2",
"DiscoveryId": "AYk_eQLmx5p5BYeS8cr_",
"DeviceName": "MJW10EPMAGSU2",
"Network": {
"TCPIP": {
"Address": "10.39.248.130"
}
},
"OS": {
"Version": "Windows 10",
"Name": "Windows 10"
},
"System": {
"Model": "VMware7,1"
}
}
],
"@odata.nextLink": "https://nvuprd-sfc.ivanticloud.com:443/api/apigatewaydataservices/v1/devices?$scrollID=ID"GET Devices Metadata
Request URI
https://<hostname>/api/apigatewaydataservices/v1/devicesMetadata
Example Response
The responses are available in XML format, and the OData metadata describes the device object and its properties and attributes.
Pagination
When using the Discovery API to retrieve Devices, the server paginates the data, you receive a portion of the results at a time. Typically, you will get 10 to 20 objects per response.
Pagination applies only to retrieving details about people and devices and does not apply to metadata calls.
To access additional results, check the bottom of the response for the @odata.nextLink property. This property contains a URL for fetching the next set of results. The URL includes a scrollID parameter, for example:
https://<hostname>/api/apigatewaydataservices/v1/devices?$scrollID=<id>
Use this scrollID in subsequent requests to continue retrieving data. Keep calling the next link until you receive an empty response, indicating that all results have been fetched.
ScrollID has a 5-minute timeout. If you don't use it within 5 minutes, it will expire. In this case, you'll need to restart the process with your initial request to get a new @odata.nextLink and a fresh scrollID.