Documentation is now available for the Fall 2020 Update release!

Get resource UUIDs by OS name

This endpoint is used to to retrieve a paginated list of resource UUIDs by the OS name.

Leave Feedback

URL

GET https://{api-url}/api/v2/tenants/{tenantId}/agents/{OSName}/resourceUUIDSByOSName

Sample URLs

https://{api-url}/api/v2/tenants/client_4/agents/Ubuntu 18.04.3 LTS/resourceUUIDSByOSName
https://{api-url}/api/v2/tenants/client_4/agents/Ubuntu 18.04.3 LTS/resourceUUIDSByOSName?pageNo=1&pageSize=10&isDescendingOrder=true&sortName=uniqueId

Header format

HeaderValue
AuthorizationBearer {accessToken}
Content-typeapplication/json
Acceptapplication/json

Status code

200 OK

Parameters

All fields are mandatory unless specified otherwise.

PropertyValueDescription
OSNameStringExamples: Ubuntu 18.04.3 LTS, CentOs. Default: NULL

Request parameters

All fields are mandatory unless specified otherwise.

>
PropertyDescription
pageNo(Optional) Default: 1
pageSize(Optional) Default: 100
isDescendingOrder(Optional) Default: true
sortName(Optional) Default: uniqueId

Sample response

{
    "results": [
        {
            "uniqueId": "bfc1f106-378c-449c-aa24-5b7cdde9ec46",
            "type": "DEVICE"
        },
        {
            "uniqueId": "b8f16f96-ff22-45c6-8033-f43eff29b9b4",
            "type": "DEVICE"
        }
        ],
    "totalResults": 2,
    "orderBy": "uniqueId",
    "pageNo": 1,
    "pageSize": 100,
    "totalPages": 1,
    "nextPage": false,
    "previousPageNo": 0,
    "descendingOrder": true
}