| Name | Type | Description | Notes |
|---|---|---|---|
| baseline | Object | If the template is `baseline-comparison` or `executive-overview` the baseline scan to compare against. This can be the `first` scan, the `previous` scan, or a scan as of a specified date. Defaults to `previous`. | [optional] |
| bureau | String | The name of the bureau for a CyberScope report. Only used when the format is `"cyberscope-xml"`. | [optional] |
| component | String | The name of the component for a CyberScope report. Only used when the format is `"cyberscope-xml"`. | [optional] |
| database | ReportConfigDatabaseResource | Configuration for database export. Only used when the format is `"database-export"`. | [optional] |
| ReportEmail | Email distribution settings for the report. | [optional] | |
| enclave | String | The name of the enclave for a CyberScope report. Only used when the format is `"cyberscope-xml"`. | [optional] |
| filters | ReportConfigFiltersResource | Filters applied to the contents of the report. The supported filters for a report vary by format and template. <div class="properties"> <div class="property-info"> <span class="property-name">categories</span> <span class="param-type complex">Object</span> <div class="redoc-markdown-block">The vulnerability categories to include or exclude in the report. Only included or excluded may be specified, not both.</div> </div> <div class="properties nested"> <div class="property-info"> <span class="property-name">included</span> <span class="param-type param-array-format integer">Array[string]</span> <div class="redoc-markdown-block">The identifiers of the vulnerability categories to included in the report.</div> </div> <div class="property-info"> <span class="property-name">excluded</span> <span class="param-type param-array-format integer">Array[string]</span> <div class="redoc-markdown-block">The identifiers of the vulnerability categories to exclude in the report.</div> </div> </div> <div class="property-info"> <span class="property-name">severity</span> <span class="param-type">string</span> <div class="param-enum"> <span class="param-enum-value string">"all"</span> <span class="param-enum-value string">"critical"</span> <span class="param-enum-value string">"critical-and-severe"</span> </div> <div class="redoc-markdown-block">The vulnerability severities to include in the report.</div> </div> <div class="property-info"> <span class="property-name">statuses</span> <span class="param-type param-array-format integer">Array[string]</span> <div class="param-enum"> <span class="param-enum-value string">"vulnerable"</span> <span class="param-enum-value string">"vulnerable-version"</span> <span class="param-enum-value string">"potentially-vulnerable"</span> <span class="param-enum-value string">"vulnerable-and-validated"</span> </div> <div class="redoc-markdown-block">The vulnerability statuses to include in the report. If <code>"vulnerable-and-validated"</code> is selected no other values can be specified. </div> </div> </div> The following filter elements may be defined for non-templatized report formats: | Format |
| format | String | The output format of the report. The format will restrict the available templates and parameters that can be specified. | [optional] |
| frequency | ReportFrequency | The recurring frequency with which to generate the report. | [optional] |
| id | Integer | The identifier of the report. | [optional] |
| language | String | The locale (language) in which the report is generated | [optional] |
| links | Array<Link> | Hypermedia links to corresponding or related resources. | [optional] |
| name | String | The name of the report. | [optional] |
| organization | String | The organization used for a XCCDF XML report. Only used when the format is `"xccdf-xml"`. | [optional] |
| owner | Integer | The identifier of the report owner. | [optional] |
| policies | Array<Integer> | If the template is `rule-breakdown-summary`, `top-policy-remediations`, or `top-policy-remediations-with-details` the identifiers of the policies to report against. | [optional] |
| policy | Integer | The policy to report on. Only used when the format is `"oval-xml"`, `""xccdf-csv"`, or `"xccdf-xml"`. | [optional] |
| query | String | SQL query to run against the Reporting Data Model. Only used when the format is `"sql-query"`. | [optional] |
| range | RangeResource | If the template is `vulnerability-trends`, `r7-vulnerability-exceptions`, or `r7-discovered-assets` the date range to trend over. | [optional] |
| remediation | RemediationResource | If the template is `prioritized-remediations`, `prioritized-remediations-with-details`, `top-policy-remediations`, or `top-policy-remediations-with-details` the remediation display settings. | [optional] |
| risk_trend | RiskTrendResource | Configuration details for risk trending output. | [optional] |
| scope | ReportConfigScopeResource | The scope of the report. Scope is an object that has the following properties that vary by format and template: <div class="properties"> <div class="property-info"> <span class="property-name">assets</span> <span class="param-type param-array-format integer">Array[integer <int32>]</span> <div class="redoc-markdown-block">The identifiers of the assets to report on.</div> </div> <div class="property-info"> <span class="property-name">sites</span> <span class="param-type param-array-format integer">Array[integer <int32>]</span> <div class="redoc-markdown-block">The identifiers of the sites to report on.</div> </div> <div class="property-info"> <span class="property-name">assetGroups</span> <span class="param-type param-array-format integer">Array[integer <int32>]</span> <div class="redoc-markdown-block">The identifiers of the asset to report on.</div> </div> <div class="property-info"> <span class="property-name">tags</span> <span class="param-type param-array-format integer">Array[integer <int32>]</span> <div class="redoc-markdown-block">The identifiers of the tag to report on.</div> </div> <div class="property-info"> <span class="property-name">scan</span> <span class="param-type param-array-format integer">integer <int32></span> <div class="redoc-markdown-block">The identifier of the scan to report on.</div> </div> </div> The following scope elements may be defined for non-templatized report formats: | Format |
| storage | ReportStorage | The additional storage location and path. | [optional] |
| template | String | The template for the report (only required if the format is templatized). | [optional] |
| timezone | String | The timezone the report generates in, such as `"America/Los_Angeles"`. | [optional] |
| users | Array<Integer> | The identifiers of the users granted explicit access to the report. | [optional] |
| version | String | The version of the report Data Model to report against. Only used when the format is `"sql-query"`. | [optional] |
This repository has been archived by the owner on Sep 12, 2024. It is now read-only.