Linux Patch Groups

A Linux patch group defines a set of patches that you want to scan for or deploy.

Base URL

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

Supported Requests

Method URL Input Return

DELETE

https://<consoleFQDN:port>/st/console/api/v1.0/linux/patch/groups/{patchgroupId}

  Success Code

https://<consoleFQDN:port>/st/console/api/v1.0/linux/patch/groups/{patchgroupId}/patches

Request Body Patches Success Code

https://<consoleFQDN:port>/st/console/api/v1.0/linux/patch/groups/{patchgroupId}/patches/{patchId}

 

 Success Code

https://<consoleFQDN:port>/st/console/api/v1.0/linux/patch/groups/{patchgroupId}/patches/cves

Request Body CVEs

Success Code

GET

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

  LinuxPatchGroup

https://<consoleFQDN:port>/st/console/api/v1.0/linux/patch/groups/{patchgroupId}

  LinuxPatchGroup

https://<consoleFQDN:port>/st/console/api/v1.0/linux/patch/groups/{patchgroupId}/patches

  LinuxPatchLinks

https://<consoleFQDN:port>/st/console/api/v1.0/linux/patch/groups/{patchgroupId}/usedby

 

LinuxPatchGroupUsedby

POST

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

Request Body LinuxPatchGroup

https://<consoleFQDN:port>/st/console/api/v1.0/linux/patch/groups/{patchgroupId}/patches

Request Body Patches Success Code

https://<consoleFQDN:port>/st/console/api/v1.0/linux/patch/groups/{patchgroupId}/patches/cves

Request Body CVEs Success Code

PUT

https://<consoleFQDN:port>/st/console/api/v1.0/linux/patch/groups/{patchgroupId}

Request Body Success Code

Input Models

Name Type Description

createdByMe

Boolean

Returns only those items created by the user.

This parameter will be removed in a future release and should only be used in legacy requests.

name

String

Returns the items whose name matches the specified name.

path

String

Returns the items containing the path.
Name Required? Type Default Value Description

name

Yes

String

None

Linux patch group name.

path

No

String

None

The path to the group.
Name Required? Type Default Value Description

errorPolicy

No

Enum

Throw

Determines if the call will throw an error when encountering an invalid ID.

  • Throw: The entire request will be rejected.
  • Omit: The problem area will be omitted but the rest of the request will be completed.

patchIds

Yes

Guid

None

The patch IDs.
Name Required? Type Default Value Description

cves

Yes

String

None

The CVE IDs. The values must be specified within an array.

errorPolicy

No

Enum

Throw

Determines if the call will throw an error when encountering an invalid ID.

  • Throw: The entire request will be rejected.
  • Omit: The problem area will be omitted but the rest of the request will be completed.

Example with Sample Response

Find all Linux patch groups

GET Request

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

Sample Response

Copy 
{
    "count": 1,
    "value": [
        {
            "id": 1,
            "links": {
                "self": {
                    "href": "https://device-name.example.com:3121/st/console/api/v1.0/linux/patch/groups/1"
                },
                "patches": {
                    "href": "https://device-name.example.com:3121/st/console/api/v1.0/linux/patch/groups/1/patches"
                },
                "usedby": {
                    "href": "https://device-name.example.com:3121/st/console/api/v1.0/linux/patch/groups/1/usedby"
                }
            },
            "name": "Sample-Linux-Patch-Group"
        }
    ]
}

Other Request Examples

DELETE Request

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

DELETE Request

https://<consoleFQDN:port>/st/console/api/v1.0/linux/patch/groups/1/patches/0002b0ed-0000-0000-0000-000000000000

DELETE Request

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

{
    "patchIds": ["0002b0ed-0000-0000-0000-000000000000", "0002b07f-0000-0000-0000-000000000000"]
}

DELETE Request

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

{
    "cves": ["CVE-2019-11500", "CVE-2019-10102"]
}

GET Request

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

GET Request

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

GET Request

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

POST Request

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

{
    "name": "SampleGroup",
    "Description": "A sample group created via the REST API"
}

POST Request

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

{
    "patchIds": ["0002b0ed-0000-0000-0000-000000000000", "0002b07f-0000-0000-0000-000000000000"]
}

POST Request

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

{
    "cves": ["CVE-2019-11500", "CVE-2019-10102"]
}

PUT Request

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

{
    "name": "New Name"
}

For a fuller understanding of how to create and use a Linux patch group, see PowerShell Example: Create and Install an Agent.

Output Models

Name Type Description

id

String

Patch group ID.

links

Links

Links for the patch group.

name

String

Specifies the patch group name.

path

String

The path that describes the location of the group within the Linux Patch Groups list in the navigation pane.
Name Type Description

links

Links

Links for the patch.

patchId

Guid

The unique ID for the patch.
Name Type Description

name

String

Specifies the name of the Linux patch scan configuration.

usageType

Enum

The component type that use the Linux patch group.