Get compliance of resource and baseline

URL

GET https://{api-url}/api/v2/tenants/{tenantId}/resources/{resourceId}/baselines/{baseLineId}/patches

Sample URLs

To retrieve the list of assigned patches in a baseline:

https://{api-url}/api/v2/tenants/client_14/resources/73e3580a-53f8-4a01-bafe-db74fc5e75e3/baselines/PBL-1bfe0514-f882-4300-8d62-7e67d0ec149c/patches

To retrieve the list of assigned patches with pagination in a descending and alphabetical order:

https://{api-url}/api/v2/tenants/client_14/resources/73e3580a-53f8-4a01-bafe-db74fc5e75e3/baselines/PBL-1bfe0514-f882-4300-8d62-7e67d0ec149c/patches?pageNo=1&pageSize=10&isDescendingOrder=true&sortName=name

Notes

There are special characters that can be used in a query string:

(+) represents the next field and must be URL-encoded.
(:) represents equals. An example is key : value.
Space characters must be URL-encoded.

Parameters

All parameters are optional:

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	Values	Description
category	CRITICAL, SECURITY	Category in which a patch is created. Example: SECURITY
patchName	NA	Unique name of a patch.
patchId	NA	Unique ID of a patch. Use the Search Patches API to retrieve patch details based on their IDs.
externalId	NA	External ID of a patch.
severity	NA	Severity of a patc.h

Sample response

{
	"results": [{
		"approvalStatus": "NOT_APPROVED",
		"patchStatus": "MISSING",
		"installedStatus": "NEED_TO_INSTALL",
		"scanTime": "2019-05-29T08:56:11+0000",
		"installedTime": "",
		"approvedTime": "",
		"patch": {
			"id": "PATCH-6ca40150-56b1-12ca-2b15-22a6ea787790",
			"name": "Security Update for Windows Server 2008",
			"externalId": "10000",
			"category": "Critical Updates - Windows 8",
			"releaseTime": "2019-05-29T08:53:22+0000",
			"type": "WINDOWS",
			"rebootRequired": false,
			"rating": {
				"rating": "CRITICAL"
			}
		},
		"resource": {
			"id": "bae45962-981e-4611-bfef-b272c8d8aa87",
			"hostName": "",
			"ipAddress": "172.31.26.40",
			"type": "Windows",
			"aliasName": "alias name",
			"resourceName": "172.31.26.40",
			"consoles": [],
			"resourceType": "Windows",
			"frequency": 0,
			"paused": false,
			"deleted": false,
			"validateSSL": false,
			"port": 0,
			"encrypted": false,
			"timeout": 0,
			"days": 0,
			"ts": 0,
			"clientId": 0,
			"locationOffset": 0,
			"totalLocations": 0,
			"receiverHostPort": 0
		}
	}],
	"totalResults": 1,
	"orderBy": "name",
	"pageNo": 1,
	"pageSize": 100,
	"totalPages": 1,
	"nextPage": false,
	"previousPageNo": 0,
	"descendingOrder": true
}