Linux Patch Scan Configuration
A Linux patch scan configuration defines how a patch scan will be performed. With a patch scan configuration you can:
•Specify the types of patches and the vendor severity level of those patches that should be included in the scan
•Specify one or more Linux patch groups that contain the patches you want to use as a baseline
•Identify the agent policies that are currently using this configuration
Base URL
https://<consoleFQDN:port>/st/console/api/v1.0/linux/patch/scanconfigurations
Supported Requests
| Method | URL | Input | Return |
|---|---|---|---|
|
DELETE |
https://<consoleFQDN:port>/st/console/api/v1.0/linux/patch/scanconfigurations/{patch scan configuration id} |
|
Success code |
|
GET |
https://<consoleFQDN:port>/st/console/api/v1.0/linux/patch/scanconfigurations |
||
|
https://<consoleFQDN:port>/st/console/api/v1.0/linux/patch/scanconfigurations/{patch scan configuration id} |
|||
|
https://<consoleFQDN:port>/st/console/api/v1.0/linux/patch/scanconfigurations/{patch scan configuration id}/usedby |
|||
|
POST |
https://<consoleFQDN:port>/st/console/api/v1.0/linux/patch/scanconfigurations |
||
|
PUT |
https://<consoleFQDN:port>/st/console/api/v1.0/linux/patch/scanconfigurations/{patch scan configuration id} |
Success code |
Input Models
URL Parameters
| 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. |
Request Body
| Name | Required? | Type | Default Value | Description |
|---|---|---|---|---|
|
description |
No |
String |
None |
Provides a description that explains the purpose of this scan configuration. |
|
filter |
Only for a PUT |
None |
Specifies what to scan for (patch group and/or patch type). |
|
|
name |
Yes |
String |
None |
Specifies the patch scan configuration name. |
|
path |
No |
String |
None |
The path that describes the location of the configuration within the Linux Patch Scan Configurations list in the navigation pane. |
Example with Sample Response
Create a Linux patch scan configuration
POST Request
https://<consoleFQDN:port>/st/console/api/v1.0/linux/patch/scanconfigurations
{ "name": "Sample Linux Patch Scan Config", "description": "Sample for demonstration purposes"}Sample Response
{
"createdBy": "example\\joe.admin",
"description": "Sample for demonstration purposes",
"filter": {
"patchTypeSeverities": "SecurityCritical, SecurityImportant, BugFix"
},
"id": "41bc2c50-441f-4647-9d85-7058a5251b19",
"isSystem": false,
"links": {
"self": {
"href": "https://device-name.example.com:3121/st/console/api/v1.0/linux/patch/scanconfigurations/41bc2c50-441f-4647-9d85-7058a5251b19"
},
"usedby": {
"href": "https://device-name.example.com:3121/st/console/api/v1.0/linux/patch/scanconfigurations/41bc2c50-441f-4647-9d85-7058a5251b19/usedby"
}
},
"name": "Sample Linux Patch Scan Config"
}Other Request Examples
Delete a Linux patch scan configuration with ID 01234567-89AB-CDEF-0123-456789ABCDEF
DELETE Request
https://<consoleFQDN:port>/st/console/api/v1.0/linux/patch/scanconfigurations/01234567-89AB-CDEF-0123-456789ABCDEF
Find all Linux patch scan configurations
GET Request
https://<consoleFQDN:port>/st/console/api/v1.0/linux/patch/scanconfigurations
Find a Linux patch scan configuration with ID 01234567-89AB-CDEF-0123-456789ABCDEF
GET Request
https://<consoleFQDN:port>/st/console/api/v1.0/linux/patch/scanconfigurations/01234567-89AB-CDEF-0123-456789ABCDEF
Find a Linux patch scan configuration named Config-Test
GET Request
https://<consoleFQDN:port>/st/console/api/v1.0/linux/patch/scanconfigurations?name=Config-Test
Find all items that are using the Linux patch scan configuration with ID 01234567-89AB-CDEF-0123-456789ABCDEF
GET Request
https://<consoleFQDN:port>/st/console/api/v1.0/linux/patch/scanconfigurations/01234567-89AB-CDEF-0123-456789ABCDEF/usedby
Update the name of a Linux patch scan configuration with ID 01234567-89AB-CDEF-0123-456789ABCDEF
PUT Request
https://<consoleFQDN:port>/st/console/api/v1.0/linux/patch/scanconfigurations/0BA381B1-1D64-468A-9E64-80D39284D939
{
"name": "New Name",
"filter": {
"patchTypeSeverities": "BugFix",
"patchGroupIds": [1]
}
}Output Models
LinuxPatchScanConfiguration
| Name | Type | Description |
|---|---|---|
|
createdBy |
String |
The name of the user who created the scan configuration. |
|
description |
String |
Provides a description that explains the purpose of this scan configuration. |
|
filter |
Specifies the filters to use during a scan. |
|
|
id |
Guid |
Unique identifier for the scan configuration. |
|
isSystem |
Boolean |
Indicates if this configuration is provided by the system. |
|
links |
Links |
Links for the scan configuration. |
|
name |
String |
Specifies the patch scan configuration name. |
|
path |
String |
The path that describes the location of the configuration within the Linux Patch Scan Configurations list in the navigation pane. |
LinuxPatchScanFilter
| Name | Type | Description |
|---|---|---|
|
patchGroupIds |
Integer[] |
The IDs of the patch groups to use. |
|
patchTypeSeverities |
Enum |
|
LinuxPatchScanConfigUsedby
| Name | Type | Description |
|---|---|---|
|
name |
String |
Specifies the name of the agent policy that uses the Linux patch scan configuration. |
|
usageType |
Enum |
The component type that uses the Linux patch scan configuration. |