Get patching status of all devices in a patch configuration

URL

GET https://{api-url}/api/v2/tenants/{tenantId}/patches/{jobId}/install/status

Sample URLs

https://{api-url}/api/v2/tenants/client_16/patches/PATCHCONF-2f2e0ba6-b062-4359-9bf6-f194f1bb11ca/install/status

https://{api-url}/api/v2/tenants/client_16/patches/PATCHCONF-2f2e0ba6-b062-4359-9bf6-f194f1bb11ca/install/status?pageNo=1&pageSize=1&isDescendingOrder=false&sortName=ipAddress

https://{api-url}/api/v2/tenants/client_16/patches/PATCHCONF-2f2e0ba6-b062-4359-9bf6-f194f1bb11ca/install/status?queryString=aliasName:admin-pc&ipAddress:10.0.3.15

Parameters

Field	Default Value
pageNo={pageNo}	1
pageSize={pageSize}	100
isDescendingOrder={true/false}	true
sortName={field}	name
queryString={queryString}	NA

NA indicates that the value is not applicable.

Query variables

Query Variables	Description
id	Unique ID of the device.
ipAddress	IP address of the device.
resourceName	Name of the device.
hostName	Host name of the device.
aliasName	Alias name of the device.
resourceType	Type of the device.

Status code

200 OK

Sample responses

{
    "results": [
        {
            "device": {
                "id": "2ca44d27-888e-4ddb-a5ee-89eb962798fe",
                "generalInfo": {
                    "osName": "Ubuntu 14.04.5 LTS",
                    "ipAddresses": "10.0.4.15",
                    "hostName": "opsrampdev",
                    "resourceType": "Linux",
                    "resourceName": "",
                    "aliasName": ""
                },
                "clientUniqueId": "client_16",
                "type": "DEVICE"
            },
            "installStatus": {
                "lastPatchTriggeredDate": "2019-06-21T13:51:39+0000",
                "lastPatchInstalledDate": "2019-06-21T13:56:10+0000",
                "lastMachineRebootDate": "2019-06-24T19:42:18+0000"
            }
        },
        {
            "device": {
                "id": "2771a95d-496a-4c0b-a4f4-1cf1b7f94045",
                "generalInfo": {
                    "osName": "Microsoft Windows 7 Professional Service Pack 1, 32-bit",
                    "ipAddresses": "10.0.3.15",
                    "hostName": "ADMIN-PC",
                    "resourceType": "Work Station",
                    "resourceName": "",
                    "aliasName": "admin-pc",
                    "osBuildNumber": "7601"
                },
                "clientUniqueId": "client_16",
                "type": "DEVICE"
            },
            "installStatus": {
                "lastPatchTriggeredDate": "2019-06-21T13:51:39+0000"
            }
        }
    ],
    "totalResults": 2,
    "orderBy": "name",
    "pageNo": 1,
    "pageSize": 100,
    "totalPages": 1,
    "nextPage": false,
    "previousPageNo": 0,
    "descendingOrder": true
}

A sample response where the query is based on ipAddress:

{
    "results": [
        {
            "device": {
                "id": "2771a95d-496a-4c0b-a4f4-1cf1b7f94045",
                "generalInfo": {
                    "osName": "Microsoft Windows 7 Professional Service Pack 1, 32-bit",
                    "ipAddresses": "10.0.3.15",
                    "hostName": "ADMIN-PC",
                    "resourceType": "Work Station",
                    "resourceName": "",
                    "aliasName": "admin-pc",
                    "osBuildNumber": "7601"
                },
                "clientUniqueId": "client_16",
                "type": "DEVICE"
            },
            "installStatus": {
                "lastPatchTriggeredDate": "2019-06-21T13:51:39+0000"
            }
        }
    ],
    "totalResults": 2,
    "orderBy": "ipAddress",
    "pageNo": 1,
    "pageSize": 1,
    "totalPages": 2,
    "nextPage": true,
    "nextPageNo": 2,
    "previousPageNo": 0,
    "descendingOrder": false
}

A sample response where the query is based on aliasName and ipAddress:

{
    "results": [
        {
            "device": {
                "id": "2771a95d-496a-4c0b-a4f4-1cf1b7f94045",
                "generalInfo": {
                    "osName": "Microsoft Windows 7 Professional Service Pack 1, 32-bit",
                    "ipAddresses": "10.0.3.15",
                    "hostName": "ADMIN-PC",
                    "resourceType": "Work Station",
                    "resourceName": "",
                    "aliasName": "admin-pc",
                    "osBuildNumber": "7601"
                },
                "clientUniqueId": "client_16",
                "type": "DEVICE"
            },
            "installStatus": {
                "lastPatchTriggeredDate": "2019-06-21T13:51:39+0000"
            }
        }
    ],
    "totalResults": 1,
    "orderBy": "name",
    "pageNo": 1,
    "pageSize": 100,
    "totalPages": 1,
    "nextPage": false,
    "previousPageNo": 0,
    "descendingOrder": true
}

A sample response where the query is based on aliasName:

{
    "results": [
        {
            "device": {
                "id": "2771a95d-496a-4c0b-a4f4-1cf1b7f94045",
                "generalInfo": {
                    "osName": "Microsoft Windows 7 Professional Service Pack 1, 32-bit",
                    "ipAddresses": "10.0.3.15",
                    "hostName": "ADMIN-PC",
                    "resourceType": "Work Station",
                    "resourceName": "",
                    "aliasName": "admin-pc",
                    "osBuildNumber": "7601"
                },
                "clientUniqueId": "client_16",
                "type": "DEVICE"
            },
            "scanStatus": {
                "lastPatchScanDate": "2019-06-23T11:42:56+0000",
                "lastPatchScanStatus": "success",
                "missingPatchesBeforeScan": 0,
                "missingPatchesAfterScan": 0,
                "noOfMissingPatchesFoundInLastScan": 0
            }
        }
    ],
    "totalResults": 1,
    "orderBy": "name",
    "pageNo": 1,
    "pageSize": 100,
    "totalPages": 1,
    "nextPage": false,
    "previousPageNo": 0,
    "descendingOrder": true
}

A sample response where the query is based on resourceType:

{
    "results": [
        {
            "device": {
                "id": "2ca44d27-888e-4ddb-a5ee-89eb962798fe",
                "generalInfo": {
                    "osName": "Ubuntu 14.04.5 LTS",
                    "ipAddresses": "10.0.4.15",
                    "hostName": "opsrampdev",
                    "resourceType": "Linux",
                    "resourceName": "",
                    "aliasName": ""
                },
                "clientUniqueId": "client_16",
                "type": "DEVICE"
            },
            "installStatus": {
                "lastPatchTriggeredDate": "2019-06-21T13:51:39+0000",
                "lastPatchInstalledDate": "2019-06-21T13:56:10+0000",
                "lastMachineRebootDate": "2019-06-24T19:42:18+0000"
            }
        }
    ],
    "totalResults": 1,
    "orderBy": "name",
    "pageNo": 1,
    "pageSize": 100,
    "totalPages": 1,
    "nextPage": false,
    "previousPageNo": 0,
    "descendingOrder": true
}

A sample response where the query is based on a specific ipAddress:

{
    "results": [
        {
            "device": {
                "id": "2771a95d-496a-4c0b-a4f4-1cf1b7f94045",
                "generalInfo": {
                    "osName": "Microsoft Windows 7 Professional Service Pack 1, 32-bit",
                    "ipAddresses": "10.0.3.15",
                    "hostName": "ADMIN-PC",
                    "resourceType": "Work Station",
                    "resourceName": "",
                    "aliasName": "admin-pc",
                    "osBuildNumber": "7601"
                },
                "clientUniqueId": "client_16",
                "type": "DEVICE"
            },
            "installStatus": {
                "lastPatchTriggeredDate": "2019-06-21T13:51:39+0000"
            }
        }
    ],
    "totalResults": 1,
    "orderBy": "name",
    "pageNo": 1,
    "pageSize": 100,
    "totalPages": 1,
    "nextPage": false,
    "previousPageNo": 0,
    "descendingOrder": true
}

A sample response where the query is based on a specific hostName:

{
    "results": [
        {
            "device": {
                "id": "2ca44d27-888e-4ddb-a5ee-89eb962798fe",
                "generalInfo": {
                    "osName": "Ubuntu 14.04.5 LTS",
                    "ipAddresses": "10.0.4.15",
                    "hostName": "opsrampdev",
                    "resourceType": "Linux",
                    "resourceName": "",
                    "aliasName": ""
                },
                "clientUniqueId": "client_16",
                "type": "DEVICE"
            },
            "installStatus": {
                "lastPatchTriggeredDate": "2019-06-21T13:51:39+0000",
                "lastPatchInstalledDate": "2019-06-21T13:56:10+0000",
                "lastMachineRebootDate": "2019-06-24T19:42:18+0000"
            }
        }
    ],
    "totalResults": 1,
    "orderBy": "name",
    "pageNo": 1,
    "pageSize": 100,
    "totalPages": 1,
    "nextPage": false,
    "previousPageNo": 0,
    "descendingOrder": true
}

A sample response where the query is based on deviceId:

{
    "results": [
        {
            "device": {
                "id": "2771a95d-496a-4c0b-a4f4-1cf1b7f94045",
                "generalInfo": {
                    "osName": "Microsoft Windows 7 Professional Service Pack 1, 32-bit",
                    "ipAddresses": "10.0.3.15",
                    "hostName": "ADMIN-PC",
                    "resourceType": "Work Station",
                    "resourceName": "",
                    "aliasName": "admin-pc",
                    "osBuildNumber": "7601"
                },
                "clientUniqueId": "client_16",
                "type": "DEVICE"
            },
            "installStatus": {
                "lastPatchTriggeredDate": "2019-06-21T13:51:39+0000"
            }
        }
    ],
    "totalResults": 1,
    "orderBy": "name",
    "pageNo": 1,
    "pageSize": 100,
    "totalPages": 1,
    "nextPage": false,
    "previousPageNo": 0,
    "descendingOrder": true
}