Security Controls REST API

Home 

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.

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/{patch id}

 

Success or failure code.

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

Request Body

Success or failure code.

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

Request Body

ErrorPolicy (optional)

Success or failure code.

     

GET

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

URL Parameters

An array of patch groups.

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

 

Patch groups

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

BulletinKBCveInput

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

ErrorPolicy (optional)

A patch group.

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

Request Body (VulnerabilityIds)

Success or failure code.

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

URL Parameters (IgnoreInvalidIds)

Request Body (VulnerabilityIds)

Success or failure code.

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

Request Body

Success or failure code.

     

PUT

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

Request Body

The patch group.

Input Models

URL Parameters

Name Type Description

count

Integer

Provide the count of items to return. The maximum value is 50.

createdByMe

Boolean

Returns only those items created by the user.

name

String

Returns the items whose name matches the specified name.

start

Integer

Sets the starting point.

path

String

Returns the groups containing the path.

ignoreInvalidIds

 

Applies only to the POST request that reference this in the body.

Request Body

Name Required? Type Default Value Description
cve No String None

Sets the CVE.

Note: Applies to the https://<consoleFQDN:port>/st/console/api/v1.0/patch/groups/{id of patch group}/patches/cve {CvePatchGroupInput} request.

id

No

Int32

None

Specifies the patch group ID.

Note: Applies to the https://<consoleFQDN:port>/st/console/api/v1.0/patch/groups request.

name

Yes

String

None

Specifies the patch group name.

path

No

String

None

The path that describes the location of the patch group within the Patch Templates and Groups list in the navigation pane.

Example: Lab\Servers

vulnerabilityIds

     

Applies only to the POST requests that reference this in the body.

Example

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

Find a patch group named PatchGroup-Test

https://<consoleFQDN:port>/st/console/api/v1.0/patch/groups?name=PatchGroup-Test

Find the first four asset groups

https://<consoleFQDN:port>/st/console/api/v1.0/patch/groups?count=4&start=0

Find all patch groups created by the current user

https://<consoleFQDN:port>/st/console/api/v1.0/patch/groups?createdbyme=true

Remove the patch group with ID 1

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

Add all vulnerabilities for CVE-2013-0787 to patch group with ID 1

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

{ "CVE" : "CVE-2013-0787", "ErrorPolicy" : "Throw"}

Add two vulnerabilities with IDs 11408 and 15246 to the patch group with ID 1

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

[11408, 15246]

 

Output Models

Vulnerability

Name Type Description

bulletinId

String

The bulletin ID

cve

String[]

The list of associated CVEs.

iavaId

String

IAVA ID.

id

Integer

The vulnerability ID.

kb

String

The KB.

links

Links

Shows the related URLs for each vulnerability.

patchIds

Guid[]

The list of patch UIDs.

patchType

KnownPatchType

The patch type.

releaseDate

DateTime

The release date.

replacedBy

String

The list of all patches that replace this vulnerability.

revisionDate

DateTime

The revision date.

UsedBy

Name Type Description

name

String

Gets the name of the item that is using this patch group.

usageType

SummaryType

The type of component using the patch group.

SummaryType

PatchScanTemplate

AssetScanTemplate

PatchDeploymentTemplate

Favorite

PatchGroup

MachineGroup

ScanResult

AgentPolicy

PowerOptions

ServicePackGroup

PowerStatusScan

WakeOnLan

DeploymentResults

PowerShellTemplate

PowerShellScript


Was this article useful?    

The topic was:

Inaccurate

Incomplete

Not what I expected

Other