Security Controls REST API

Home 

Patches

The Patches method enables you to find and display detailed information about every product patch contained in the data definition file.

Base URL

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

Supported Requests

Method URL Input Return

GET

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

URL Parameters

Request Body

ErrorPolicy (optional)

An array of bulletin KB CVE mappings

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

 

Information about the vulnerability

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.

Request Body

The items in this table are mutually exclusive. For example, if you specify KBs you cannot specify CVEs or BulletinIDs.

Name Type Description

bulletinIds

String

A comma-delimited list of bulletin IDs.

cves

String

A comma-delimited list of CVE IDs.

kbs

String

A comma-delimited list of KB IDs.

Example

Find all patches

GET Request

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

Sample Response

{

"count": 1,

"value": [

{

"links": {

"next": {

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

}

},

"vulnerabilities": [

{

"bulletinId": "MS99-031",

"cve": [],

"id": 4693,

"kb": "Q240346",

"links": {

"self": {

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

}

},

"patchIds": [

"00000042-0000-0000-0000-000000000000"

],

"patchType": "SecurityPatch",

"releaseDate": "1999-08-25T00:00:00",

"replacedBy": [],

"revisionDate": "1999-09-08T00:00:00"

},

{ REPEAT FOR ALL BULLETIN IDs. . . }

}

]

}

]

}

Other Request Examples

Find single patch with ID 6101

GET Request

https://<consoleFQDN:port>/st/console/api/v1.0/patches/6101

Find patches associated with bulletins MS18-04 and MS18-05

GET Request

https://<consoleFQDN:port>/st/console/api/v1.0/patches?bulletinIds=MS18-04,MS18-05

Find patches associated with KB Q4093110 and Q4103729

GET Request

https://<consoleFQDN:port>/st/console/api/v1.0/patches?kbs=Q4093110,Q4103729

Find patches associated with CVE-2018-4932 and CVE-2018-4944

GET Request

https://<consoleFQDN:port>/st/console/api/v1.0/patches?cves=CVE-2018-4932,CVE-2018-4944

 

Output Models

BulletinKBCveMapping

Name Type Description

invalidIds

 

An array of CVE, KB and bulletin IDs provided by the user that are not supported.

links

Links

Shows the related URL for the bulletin ID.

vulnerabilities

Vulnerability

The vulnerability information for the supported CVEs, KBs and bulletin IDs provided by the user.

Vulnerability

Name Type Description

bulletinId

String

The bulletin ID

cve

 

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.

patchId

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.

Known Patch Types

SecurityPatch

SoftwareDistribution

SecurityTools

NonSecurityPatch

CustomActions

PatchMetadata

Name Type Description

bulletinId

String

The bulletin ID

bulletinReleaseData

DateTime

The bulletin release date.

cves

 

The CVEs

isCustom

Boolean

Set if the patch is a custom patch.

kb

String

The KB number.

links

Links

Shows the related URLs.

name

String

The patch name.

patchId

Guid

The GUID.

patchType

   

releaseDate

DateTime

The release date.

replacedBy

String

Replaced by.

vendorSeverity

 

Vendor serverity.

 


Was this article useful?    

The topic was:

Inaccurate

Incomplete

Not what I expected

Other