Patch Scans

A patch scan is used to identify the installed and missing patches on one or more target machines. You can perform a scan, display information about a scan and delete the results of a scan.

If you initiate a patch scan remotely via the REST API, you must add a session credential.

Base URL

        https://<consoleFQDN:port>/st/console/api/v1.0/patch/scans

Supported Requests

Method URL Input Return

DELETE

https://<consoleFQDN:port>/st/console/api/v1.0/patch/scans/{scan id}

 

Success or failure code.

GET

https://<consoleFQDN:port>/st/console/api/v1.0/patch/scans

URL Parameters

ScanResult

https://<consoleFQDN:port>/st/console/api/v1.0/patch/scans/{scan id}

 

Patch scan status

https://<consoleFQDN:port>/st/console/api/v1.0/patch/scans/{scan id}/machines

  PatchScanMachine

https://<consoleFQDN:port>/st/console/api/v1.0/patch/scans/{scan id}/machines/{scan machine id}/patches

 

DetectedPatches[]

POST

https://<consoleFQDN:port>/st/console/api/v1.0/patch/scans

Request Body

Operation location

Input Models

Example with Sample Response

Find a patch scan with ID 01234567-89AB-CDEF-0123-456789ABCDEF

GET Request

https://<consoleFQDN:port>/st/console/api/v1.0/patch/scans/01234567-89AB-CDEF-0123-456789ABCDEF

Sample Response

{

"consoleName": "device-name",

"definitionDate": "2018-06-25T18:13:13.343",

"definitionVersion": "2.0.2.5244",

"expectedResultTotal": 1,

"id": "01234567-89AB-CDEF-0123-456789ABCDEF",

"isComplete": true,

"links": {

"self": {

"href": "https://device-name.fakedomain.com:3121/st/console/api/v1.0/patch/scans/01234567-89AB-CDEF-0123-456789ABCDEF"

},

"machines": {

"href": "https://device-name.fakedomain.com:3121/st/console/api/v1.0/patch/scans/01234567-89AB-CDEF-0123-456789ABCDEF/machines"

},

"template": {

"href": "https://device-name.fakedomain.com:3121/st/console/api/v1.0/patch/scanTemplates/01234567-89AB-CDEF-0123-456789ABCDEF"

}

},

"name": "My Machine",

"receivedResultCount": 1,

"scanType": "Patch",

"startedOn": "2018-06-26T15:21:54.617Z",

"updatedOn": "2018-06-26T15:21:54.617Z",

"user": "SHAVLIK\\joe.coder"

}

Other Request Examples

Output Models