Linux Patch Metadata

Provides metadata information for Linux patches.

Base URL

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

Supported Requests

Method	URL	Input	Return
GET	https://<consoleFQDN:port>/st/console/api/v1.0/linux/patchmetadata	URL Parameters	LinuxPatchMetadata
GET	https://<consoleFQDN:port>/st/console/api/v1.0/linux/patchmetadata/{patchId}		LinuxPatchMetadata

Input Model

URL Parameters

Name	Type	Description
count	Int32	Provide the count of items to return. The default is 10 and the maximum value is 1000.
cves	String	Retrieve all patches for the specified CVEs.
distribution	Enum	The distribution OS name (CentOS, RedHat, etc).
errorPolicy	Enum	Determines if the call will throw an error when encountering an invalid ID. ErrorPolicy=Throw means the entire request will be rejected. ErrorPolicy=Omit means the problem area will be omitted but the rest of the request will be completed. Omit is the default value.
ids	Guid	One or more comma-separated patch IDs.
patchTypeSeverity	Enum	The valid severity types are: None = 0 SecurityUnassigned = 1 SecurityCritical = 2 SecurityImportant = 4 SecurityModerate = 8 SecurityLow = 16 BugFix = 32 Enhancement = 64
showReplacedPatches	Boolean	Show replaced patches. The default is false.
start	Guid	Specifies the patch ID to use as the starting point.

Example with Sample Response

Find patch metadata for the Linux patch with ID 0002b07f-0000-0000-0000-000000000000

GET Request

https://<consoleFQDN:port>/st/console/api/v1.0/patch/patchmetadata/0002b07f-0000-0000-0000-000000000000

Sample Response

Copy

{
    "distribution": "RedHat",
    "issuedDate": "2014-06-10T00:00:00Z",
    "links": {
        "self": {
            "href": "https://device-name.example.com:3121/st/console/api/v1.0/linux/patchmetadata/0002b07f-0000-0000-0000-000000000000"
        }
    },
    "name": "kexec-tools-2.0.4-32.el7_0.1",
    "notifications": [
        "RHBA-2014:0722"
    ],
    "packages": [
        {
            "architecture": 3,
            "name": "kexec-tools-2.0.4-32.el7_0.1.x86_64.rpm",
            "packageUpdated": "2014-06-10T00:00:00Z",
            "packageVersion": "2.0.4",
            "productId": "00004d5c-0000-0000-0000-000000000000"
        },
        {
            "architecture": 3,
            "name": "kexec-tools-eppic-2.0.4-32.el7_0.1.x86_64.rpm",
            "packageUpdated": "2014-06-10T00:00:00Z",
            "packageVersion": "2.0.4",
            "productId": "00004d5c-0000-0000-0000-000000000000"
        }
    ],
    "patchId": "0002b07f-0000-0000-0000-000000000000",
    "patchTypeSeverity": "BugFix",
    "platformEditions": [
        "Client",
        "Cluster",
        "Server",
        "Workstation"
    ],
    "replacedBy": "kexec-tools-2.0.4-32.el7_0.2",
    "requiresReboot": false
}

Other Request Examples

Output Model

LinuxPatchMetadata

Name	Type	Description
cves	string	The list of related CVEs.
distribution	Distribution	The distribution OS name.
issuedDate	DateTime	The earliest issued date for the associated notifications.
links	Links	Shows the related URLs for the patch.
name	String	The name of the patch
notifications	String	The related notifications.
packages	Package	The related packages. Each package definition consists of: architecture name packageUpdated packageVersion productId
patchId	Guid	The patch ID.
patchTypeSeverity	Enum	The patch severity type. Possible values are: None = 0 SecurityUnassigned = 1 SecurityCritical = 2 SecurityImportant = 4 SecurityModerate = 8 SecurityLow = 16 BugFix = 32 Enhancement = 64
platformEditions	String	The set of affected platform editions
replacedBy	String	Replaced by patch.
requiresReboot	Boolean	Specifies if a reboot is necessary after installing the patch.
RevisedDate	DateTime	The newest revised date for the associated notifications.