Patch Template Parameters

General Info

action={create|update}

Required

String

Specify the action you want to take.

report_format=xml

Required

File

XML report format is supported.

template_id={value}

Required for update request

Integer

The template ID to update.

title={value}

Optional

String

A string value for the title (max of 64 characters).

owner={value}

Optional

String

The name of the owner of this template.

See Template Owner.

Target Options

patch_evaluation=
{qidbased|classic}

 Required

Boolean

Specify classic to choose Classic patch evaluation or specify qidbased to choose QID based patch evaluation.

asset_groups={value}

Optional 

Integer

Asset groups to include in the report. Multiple asset groups are comma separated.

asset_group_ids={value}

Optional 

Integer

Specify the ID of the asset group(s) to report on. Multiple asset group IDs are comma separated. We'll report on all the IPs in the asset groups.

tag_set_by={name|id}

Optional 

Integer

Specify the name of the tags or the ID of the tags for the hosts you want to report on. Multiple tag names or tag IDs are comma separated.

tag_include_selector={ALL|ANY}

Optional 

Boolean

Specify ALL to match all the asset tags for the hosts you want to report on (This is an AND operation). Specifying ANY will match any of the assets tags (This is an OR operation).

tag_set_include={value}

Optional 

Integer

Specify asset tags for the hosts you want to report on. We'll find the hosts in your account that match your tag selection and include them in the report.

Multiple tags can be provided using comma separated values.

tag_exclude_selector={ALL|ANY}

Optional 

Boolean

Specify ALL to match all the asset tags for the hosts you want do not want to report on (This is an AND operation). Specifying ANY will match any of the assets tags (This is an OR operation).

tag_set_exclude={value}

 Optional

Integer

Specify asset tags for the hosts you do not want to report on. We'll find the hosts in your account that match your tag selection and exclude them from the report.

Multiple tags can be provided using comma separated values.

network={value}

Valid only when the Networks feature is enabled for your account

Integer

A network name containing the IPs to include. For a new template the default network is Global Default Network.

ips={value}

Optional 

Integer

IP addresses to include in the report. Multiple IPs are comma separated.

Display Options

group_by={HOST|PATCH|OS|AG}

Optional 

Boolean

Sort and group the results of the report by any of the following:

Host = HOST

Patch = PATCH

Operating System = OS

Asset Group = AG

When include_cloud_metadata=1 is specified, then only group_by=HOST is supported.

include_cloud_metadata={0|1}

Optional

Integer

Specify 1 to include cloud metadata for your cloud assets. Only cloud metadata for AWS is supported at this time. When not specified during a create request, a value of 0 is used. When not specified during an update request, the previous value saved in the template is kept.

Notes for update patch report template request:

- If include_cloud_metadata is set to 0 in the template, then you can change the group_by option to any supported value (HOST, PATCH, OS, AG).

- If include_cloud_metadata is set to 1 in the template and you change the group_by option to a value other than HOST during an update request, then we will automatically disable the cloud metadata option and we’ll show a notification in the response, letting you know that the option was disabled as a result of the change.

- If group_by is set to a value other than HOST in the template and you specify include_cloud_metadata=1 during an update request, then an error will occur because include_cloud_metadata can only have a value of 1 when group_by is set to HOST.

include_table_of_qids_fixed={0|1}

Optional

Integer

Specify 1 to include QIDs that will be fixed by each patch.

include_patch_links={0|1}

Optional

Integer

Specify 1 to include the available links for each patch.

include_patches_from_
unspecified_vendors={0|1}

Optional

Integer

Specify 1 to include patches from unspecified vendors.

patch_severity_by=
{assigned|highest}

Optional

Boolean

Specify assigned to display severity which is assigned to the QID for the patch detection. Specify highest to display the severity which is highest across all QIDs found on the host that can be patched.

patch_cvss_score_by=
{assigned|highest|none}

Optional

Boolean

Specify the CVSS version score you want to display in reports.

assigned - CVSS score assigned to the QID for the patch detection

highest - CVSS score highest across all QIDs found on the host that can be patched.

none - Do not display CVSS scores.

cvss={all|cvssv2|cvssv3}

Optional

File

Specify the CVSS version score you want to display in reports.

all - both CVSS versions

cvssv2 - CVSS version 2

cvssv3 - CVSS version 3

display_custom_footer={0|1}

Optional

Integer

Specify 1 to include custom text in the report footer.

display_custom_footer_text={value}

Optional

String

Specify custom text like a disclosure statement or data classification (e.g. Public, Confidential). The text you enter will appear in all reports generated from this template, except reports in XML and CSV formats. Length is maximum 4000 characters.

exclude_account_id={0|1}

Optional

Integer

Specify 1 to exclude the account login ID in the filename of downloaded reports. Use this option to remove the login ID from the filename.

Filter Options

selective_vulns=
{complete|custom}

Optional

Boolean

Specify complete to show results for any and all vulnerabilities found.

Specify custom to filter your reports to specific QIDs (add static search lists) or to QIDs that match certain criteria (add dynamic search lists). For example, maybe you only want to report on vulnerabilities with severity 4 or 5. Tip - Exclude QIDs that you don't want in the report.

search_list_ids={value}

Optional

Integer

Specify QID to be included in the report. Multiple QIDs can be provided using values separated by a comma.

This parameter is required only if selective_vulns=custom.

exclude_qid_option={0|1}

Optional

Integer

Specify 1 to exclude QIDs from the report.

exclude_search_list_ids={value}

Optional

Integer

Specify QID to be excluded from the report. Multiple QIDs can be provided using values separated by a comma.

This parameter is required only if exclude_qid_option=1.

display_non_running_kernels={0|1}

Optional

Integer

Specify 1 to include a list of all vulnerabilities found on non-running kernels.

exclude_non_running_kernel={0|1}

Optional

Integer

Specify 1 to exclude vulnerabilities found on non-running kernels.

Use only one parameter at a time: highlight_arf_kernel or arf_kernel.

exclude_non_running_services={0|1}

Optional

Integer

Specify 1 to only include vulnerabilities found where the port/service is running.

exclude_qids_not_exploitable_
due_to_configuration={0|1}

Optional

Integer

Specify 1 to exclude vulnerabilities that are not exploitable because there’s a specific configuration present on the host.

selective_patches=
{complete|custom}

Optional

Boolean

Specify complete to show results for any and all patches found.

Specify custom to filter your reports to specific QIDs (add static search lists) or to QIDs that match certain criteria (add dynamic search lists). For example, maybe you only want to report on vulnerabilities with severity 4 or 5. Tip - Exclude QIDs that you don't want in the report.

exclude_patch_qid_option={0|1}

Optional

Integer

Specify 1 to exclude patch QIDs from the report.

patch_search_list_ids={value}

Optional

Integer

Specify patch QID to be included in the report. Multiple patch QIDs can be provided using values separated by a comma.

This parameter is required only if selective_patches=custom.

exclude_patch_search_
list_ids={value}

Optional

Integer

Specify patch QID to be excluded from the report. Multiple patch QIDs can be provided using values separated by a comma.

This parameter is required only if exclude_patch_qid_option=1.

found_since_days=
{7|30|90|365|NoLimit}

Optional

Boolean

Show only patches for vulnerabilities detected during the specified period of time in days. Specify NoLimit for no time limit.

User Access

global={0|1}

Optional

Integer

Share this report template with other users by making it global. Specify 1 to make it global.

report_access_users={value}

Optional

String

Specify the username to share the report with a user who wouldn't already have access to the report. Multiple usernames can be provided using values separated by a comma. Each user you add will be able to view reports generated from this template even if they don't have access to the IPs in the report.