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	BulletinKBCveMapping
GET	https://<consoleFQDN:port>/st/console/api/v1.0/patches/{id}		Vulnerability

Input Model

URL Parameters

Name	Type	Description
bulletinIds	String	A comma-delimited list of bulletin IDs.
count	Integer	Provide the count of items to return. The default is 10 and the maximum value is 1000.
cves	String	A comma-delimited list of CVE IDs.
errorPolicy	Enum	Determines if the call will throw an error when encountering an invalid ID. ErrorPolicy=Throw means the entire request will be rejected. Throw is the default value. ErrorPolicy=Omit means the problem area will be omitted but the rest of the request will be completed.
kbs	String	A comma-delimited list of KB IDs.
start	Integer	Sets the starting point. The items are sorted by their unique identifier and the starting point is the index into that sorted list.

Example with Sample Response

Find all patches

GET Request

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

Sample Response

Copy

{
    "count": 1,
    "links": {
        "next": {
            "href": "https://device-name.example.com:3121/st/console/api/v1.0/patches?count=10&start=4703"
        }
    },
    "value": [
        {
            "links": { //**** NOTE: THIS DUPLICATE LINK WILL BE ELIMINATED IN A FUTURE VERSION ****//
                "next": {
                    "href": "https://device-name.example.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.example.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

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.

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 severity.