Documentation is now available for the Fall 2020 Update release!

Get compliance of a resource and a baseline

This endpoint is used to fetch the compliance status of a resource with respect to a baseline.

Leave Feedback

URL

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

Sample URLs

To retrieve the patch compliance of a resource on a specific 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 patch compliance of a resource on a specific baseline with pagination:

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

A resource becomes non-compliant to a baseline of patches when the patch recommended by the OS vendor is not installed.

Parameters

FieldDefault 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 VariablesDescription
categoryCategory in which a patch is created.Example: SEVERITY, CRITICAL
patchNameUnique name of a patch.
patchIdUnique ID of a patch. Use the Search Patches API to retrieve patch details along with their IDs.
externalIdExternal ID of a patch.
severitySeverity of patch.

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": "Dummy Patch Name0",
                "externalId": "10000",
                "category": "Critical Updates - Windows 7",
                "releaseTime": "2019-05-29T08:53:22+0000",
                "type": "WINDOWS",
                "rebootRequired": false,
                "rating": {
                    "rating": "TESTING"
                }
            },
            "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
}