Security Controls REST API

Home 

Patch Metadata

Provides metadata information for patches.

Base URL

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

Supported Request

Method URL Input Return

GET

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

URL Parameters

Request Body

ErrorPolicy (optional)

Vendor list

Input Models

URL Parameters

Name Type Description

count

Integer

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

start

Integer

Sets the starting point.

Only one of the following can be included in a request:

bulletinIds

Comma delimited Strings

Retrieve all patches for the specified bulletins.

cves

Comma delimited Strings

Retrieve all patches for the specified CVEs.

familyIds

Comma delimited Integers

Retrieve all patches for the specified families. The IDs can be retrieved through the family metadata.

ids

Comma delimited Guids

Retrieve the specified patches.

kbs

Comma delimited Strings

Retrieve all patches for the specified KBs.

productVersionIds

Comma delimited Strings

Retrieve all patches for the specified product version. The IDs can be retrieved through the product metadata.

vendorIds

Comma delimited Integers

Retrieve all patches for the specified vendors. The IDs can be retrieved through the vendor metadata.

Request Body

Name Required? Type Default Value Description

bulletinIds

 

String

 

The bulletin IDs.

count

 

Integer

 

Gets or sets the count.

cves

 

String

 

Gets or sets the CVEs.

familyIds

 

String

 

The family IDs.

ids

 

String

 

The IDs.

kbs

 

String

 

Gets or sets the KBs.

productVersionIds

 

String

 

Vendor IDs.

start

 

Guid

 

Gets or sets the start.

vendorIds

 

String

 

Vendor IDs.

Example

Find the first two patches

GET Request

https://<consoleFQDN:port>/st/console/api/v1.0/patch/patchmetadata?count=2

Sample Response

{

"count": 2,

"links": {

"next": {

"href": "https://device-name.fakedomain.com:3121/st/console/api/v1.0/patch/patchmetadata?count=2&start=000000ba-0000-0000-0000-000000000000"

}

},

"value": [

{

"bulletinId": "MS99-031",

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

"cves": [],

"isCustom": false,

"kb": "Q240346",

"links": {

"self": {

"href": "https://device-name.fakedomain.com:3121/st/console/api/v1.0/patch/patchmetadata/00000042-0000-0000-0000-000000000000"

}

},

"name": "msjavx86_jvm.exe",

"patchId": "00000042-0000-0000-0000-000000000000",

"patchType": "SecurityPatch",

"replacedBy": "",

"vendorSeverity": "None"

},

{

"bulletinId": "MS00-068",

"bulletinReleaseDate": "2000-09-26T00:00:00",

"cves": [],

"isCustom": false,

"kb": "Q274303",

"links": {

"self": {

"href": "https://device-name.fakedomain.com:3121/st/console/api/v1.0/patch/patchmetadata/00000093-0000-0000-0000-000000000000"

}

},

"name": "WMSU28412.EXE",

"patchId": "00000093-0000-0000-0000-000000000000",

"patchType": "SecurityPatch",

"replacedBy": "",

"vendorSeverity": "None"

}

]

}

Other Request Examples

Find patch metadata for patch with ID 01234567-89AB-CDEF-0123-456789ABCDEF

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

Find patch metadata for patches associated with KB929969

https://<consoleFQDN:port>/st/console/api/v1.0/patch/patchmetadata?kbs=KB929969

Find patch metadata for patches associated with product version IDs 1432 and 1437

https://<consoleFQDN:port>/st/console/api/v1.0/patch/patchmetadata?productversionids=1432,1437

 

Output Model

PatchMetadata

Name Type Description

bulletinId

String

The bulletin ID. May be null.

bulletinReleaseDate

String

The bulletin release date.

cves

String[]

The CVEs associated with the patch.

isCustom

Boolean

Indicates if the patch is a custom patch.

kb

String

The KB number.

links

Links

Shows the related URL for the patch.

name

String

The name of the executable file.

patchId

Guid

The patch GUID.

patchType

KnownPatchType

The patch type. Possible values are SecurityPatch, SoftwareDistribution, SecurityTools, NonSecurityPatch and CustomActions.

releaseDate

DateTime

The date and time the patch was released. May be null.

replacedBy

String

The patch that replaces this patch.

vendorSeverity

 

The severity assigned by the vendor. Possible values are None, Critical, Important, Moderate and Low.

 


Was this article useful?    

The topic was:

Inaccurate

Incomplete

Not what I expected

Other