Patch Scan Templates

A patch scan template enables you to customize the way that target machines are scanned. With this function you can create, modify, find and delete patch scan templates. You cannot delete a predefined template that is provided with Security Controls.

Base URL

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

Supported Requests

Method URL Input Return

DELETE

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

 

Success or failure code.

GET

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

URL Parameters

PatchScanTemplates[]

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

 

A patch scan template.

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

 

UsedBy[]

POST

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

Request Body

A patch scan template

PUT

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

Request Body

Success or failure code.

Input Models

Example with Sample Response

Find all patch scan templates

GET Request

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

Sample Response

{

"count": 2,

"links": {

"next": {

"href": "https://device-name.fakedomain.com:3121/st/console/api/v1.0/patch/scanTemplates?count=10&start=3"

}

},

"value": [

{

"creator": "Protect",

"description": "Scans for missing and installed security patches",

"id": "4c7069eb-6e1c-4352-91fc-04d4d8abc07b",

"isSystem": true,

"links": {

"self": {

"href": "https://device-name.fakedomain.com:3121/st/console/api/v1.0/patch/scanTemplates/4c7069eb-6e1c-4352-91fc-04d4d8abc07b"

},

"usedby": {

"href": "https://device-name.fakedomain.com:3121/st/console/api/v1.0/patch/scanTemplates/4c7069eb-6e1c-4352-91fc-04d4d8abc07b/usedby"

}

},

"name": "Security Patch Scan",

"patchFilter": {

"patchGroupFilterType": "None",

"patchGroupIds": [],

"patchPropertyFilter": {

"customActions": false,

"nonSecurityPatchSeverities": "None",

"securityPatchSeverities": "Critical, Important, Moderate, Low, Unassigned",

"securityTools": false

},

"scanFor": "NecessaryExplicitlyInstalled",

"softwareDistribution": false,

"vendorFamilyProductFilter": {}

}

},

{

"creator": "Protect",

"description": "Scans for missing and installed security and non-security patches",

"id": "0acea94e-38fa-487e-bbe7-54b95aa3c883",

"isSystem": true,

"links": {

"self": {

"href": "https://device-name.fakedomain.com:3121/st/console/api/v1.0/patch/scanTemplates/0acea94e-38fa-487e-bbe7-54b95aa3c883"

},

"usedby": {

"href": "https://device-name.fakedomain.com:3121/st/console/api/v1.0/patch/scanTemplates/0acea94e-38fa-487e-bbe7-54b95aa3c883/usedby"

}

},

"name": "WUScan",

"patchFilter": {

"patchGroupFilterType": "None",

"patchGroupIds": [],

"patchPropertyFilter": {

"customActions": false,

"nonSecurityPatchSeverities": "Critical, Important, Moderate, Low, Unassigned",

"securityPatchSeverities": "Critical, Important, Moderate, Low, Unassigned",

"securityTools": false

},

"scanFor": "NecessaryExplicitlyInstalled",

"softwareDistribution": false,

"vendorFamilyProductFilter": {}

}

}

]

}

Other Request Examples

Output Models