Patch Groups

A patch group is a collection of patches that you wish to scan for and/or deploy. Patch groups can represent required or mandatory patches that have been approved for your organization. You can create, find and delete patch groups. You can also import a list of CVEs to a patch group. Security Controls will determine which patches are related to each CVE and add those patches to the patch group.

Base URL

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

Supported Requests

Method URL Input Return

DELETE

https://<consoleFQDN:port>/st/console/api/v1.0/patch/groups/{id of patch group}

 

Success or failure code.

https://<consoleFQDN:port>/st/console/api/v1.0/patch/groups/{id of patch group}/patches/{vulnerabilty id}

 

Success or failure code.

https://<consoleFQDN:port>/st/console/api/v1.0/patch/groups/{id of patch group}/patches

VulIds Request Body

Success or failure code.

https://<consoleFQDN:port>/st/console/api/v1.0/patch/groups/{id of patch group}/patches/cves

CVEs Request Body

Success or failure code.

GET

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

URL Parameters

PatchGroups[].

https://<consoleFQDN:port>/st/console/api/v1.0/patch/groups/{id of patch group}

 

A patch group.

https://<consoleFQDN:port>/st/console/api/v1.0/patch/groups/{id of patch group}/patches

 

Vulnerabilities[]

https://<consoleFQDN:port>/st/console/api/v1.0/patch/groups/{id of patch group}/usedby

 

UsedBy[]

POST

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

Request Body

A patch group.

https://<consoleFQDN:port>/st/console/api/v1.0/patch/groups/{id of patch group}/patches

VulIds URL Parameter

VulIds Request Body

Success or failure code.

https://<consoleFQDN:port>/st/console/api/v1.0/patch/groups/{id of patch group}/patches/cves

CVEs Request Body

Success or failure code.

PUT

https://<consoleFQDN:port>/st/console/api/v1.0/patch/groups/{id of patch group}

Request Body

Success or failure code.

Input Models

Example with Sample Response

Find all patch groups

GET Request

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

Sample Response

{

"count": 2,

"links": {

"next": {

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

}

},

"value": [

{

"id": 1,

"links": {

"self": {

"href": "https://device-name.fakedomain.com:3121/st/console/api/v1.0/patch/groups/1"

},

"patches": {

"href": "https://device-name.fakedomain.com:3121/st/console/api/v1.0/patch/groups/1/patches"

},

"usedby": {

"href": "https://device-name.fakedomain.com:3121/st/console/api/v1.0/patch/groups/1/usedby"

}

},

"name": "Sample Patch Group"

},

{

"id": 2,

"links": {

"self": {

"href": "https://device-name.fakedomain.com:3121/st/console/api/v1.0/patch/groups/2"

},

"patches": {

"href": "https://device-name.fakedomain.com:3121/st/console/api/v1.0/patch/groups/2/patches"

},

"usedby": {

"href": "https://device-name.fakedomain.com:3121/st/console/api/v1.0/patch/groups/2/usedby"

}

},

"name": "Security Patches Group"

}

]

}

Other Request Examples

Output Models