Qualys VM, PC APIs
Click to view navigation pane


Group Policies by Variants

Grouping of report templates varies by report template type.

Input Parameters - Policy Template SettingsInput Parameters - Policy Template Settings

Key

Required / Optional

Data Type

Description
report_group_by={value} Optional String Default: group_by_hosts. see Group By Variants for details.
include_posture_status={value} Optional Integer Default: 3. 1=Passed, 2=Failed, 3=Passed+Failed, 4=Error, 5=Passed+Error, 6=Failed+Error, 7=All
include_report_summary={true|false} Optional Boolean Default: true. Report summary section
include_host_stats={true|false} Optional Boolean Default: true. Host statistics section
include_control_stats={true|false} Optional Boolean Control statistics section
include_report_details={true|false} Optional Boolean Default: true. Detailed report rows
include_control_rationale={true|false} Optional Boolean Default: true. Control rationale
include_control_evidence Optional Boolean Default: true. Control evidence detail
include_control_ext_evidence={true|false} Optional Boolean Default: true. Extended control evidence - requires include_control_evidence: true
include_control_comments={true|false} Optional Boolean Default: true. Control comments
include_control_exceptions={true|false} Optional Boolean Default: true. Control exceptions
include_exceptions_history={true|false} Optional Boolean Default: true. Exception history - requires include_control_exceptions: true
include_host_summary={true|false} Optional Boolean Default: true. Host summary section
include_glossary={true|false} Optional Boolean Default: true. Glossary section
include_appendix={true|false} Optional Boolean Default: true. Appendix section
include_control_scan_parameter={true|false} Optional Boolean Default: true. Scan parameters - requires include_control_evidence: true
include_control_references={true|false} Optional Boolean Control references column
include_posture_modified_date={true|false} Optional Boolean Posture modified date column
include_control_previous_posture={true|false} Optional Boolean Previous posture state column
include_control_first_fail_date={true|false} Optional Boolean First failure date column
include_control_last_fail_date={true|false} Optional Boolean Last failure date column
include_control_first_pass_date={true|false} Optional Boolean First pass date column
include_control_last_pass_date={true|false} Optional Boolean Last pass date column
do_not_include_control_criticality={true|false} Optional Boolean Suppress criticality column
include_qds={true|false} Optional Boolean QDS score column
include_scan_source_details={true|false} Optional Boolean Scan Source Details section - pref-gated (enable.scan_source_details)
include_asset_trurisk={true|false} Optional Boolean TruRisk score column
custom.footer.text={value} Optional String Custom footer text
custom.footer.enabled={true|false} Optional Boolean Enable custom footer
evaluate_date_before={value} Optional String Evaluation date filter - before. Pref-gated (pc.report.host_evalution_datetimeframe)
evaluate_date_after={value} Optional String Evaluation date filter - after. Pref-gated
evaluate_date_unit={value} Optional String Relative unit: d_last, w_last, m_last, w, m, q, y. Pref-gated
evaluate_date_since={value} Optional Integer Relative "since N units". Pref-gated
evaluate_date_between={value} Optional String Date range filter. Pref-gated
last_updated_date_before={value} Optional String Last-updated date filter - before (validated as epoch)
last_updated_date_after={value} Optional String Last-updated date filter - after (validated as epoch)
last_updated_date_unit={value} Optional String Relative unit
last_updated_date_since={value} Optional Integer Relative "since N units" (validated as positive integer)
last_updated_date_between={value} Optional String Date range filter
include_control_required_values={true|false} Optional Boolean "Required values" cause-of-failure column
include_control_not_expected_values={true|false} Optional Boolean "Not expected values" cause-of-failure column
exclude_actual_values={true|false} Optional Boolean Exclude actual values from evidence
exclude_expected_values={true|false} Optional Boolean Exclude expected values from evidence
include_section_details={true|false} Optional Boolean Section ID/Name columns (CSV reports)
include_category_details={true|false} Optional Boolean Category/Sub-category columns (CSV reports)
exclude.account_id={true|false} Optional Boolean Exclude account ID from report
include_cloud_metadata={true|false} Optional Boolean Include cloud metadata columns
include_asset_tag={true|false} Optional Boolean Include asset tag column
include_control_remediation={true|false} Optional Boolean Control remediation text
include_criticality={value} Optional String Criticality filter/section
include.report.users={value} Optional String Comma-separated user IDs/usernames granted report access
include_control_chaining_scoring={true|false} Optional Boolean Control-chaining scoring section
include_host_id={true|false} Optional Boolean Host ID column
include_control_chaining_assessment_status={true|false} Optional Boolean Control-chaining assessment status
include_control_chaining_profile={true|false} Optional Boolean Control-chaining profile
include_control_chaining_cis_audit_procedure={true|false} Optional Boolean CIS audit procedure text
include_control_chaining_cis_remediation={true|false} Optional Boolean CIS remediation text
include_control_chaining_ig_mapping={true|false} Optional Boolean CIS Implementation Group mapping
include_control_chaining_criticality={true|false} Optional Boolean Control-chaining criticality
include_control_chaining_remediation={true|false} Optional Boolean Control-chaining remediation
include_control_summary={true|false} Optional Boolean Control summary section
include_control_mappings={true|false} Optional Boolean Control mappings section
include_control_tech_summary={true|false} Optional Boolean Control technology summary
host_statistics={true|false} Optional Boolean Host statistics (legacy QWEB naming)
selection.range.only_timeframe={true|false} Optional Boolean Restrict selection range to timeframe only
use_framework_filtering={true|false} Optional Boolean Enable framework-based filtering (legacy key)
trend_duration={true|false} Optional Integer Trend duration in days
scan_date_before={value} Optional String Scan date filter - before
scan_date_after={value} Optional String Scan date filter - after
scan_date_since={value} Optional Integer Relative "since N units"
scan_date_unit={value} Optional String Relative unit
scan_date_range_min={value} Optional String Scan date range - min
scan_date_range_max={value} Optional String Scan date range - max
trend_start_date={value} Optional String Trend start date
include_control_criticality={tvalue} Optional String Control criticality filter
include_pa_report_qds={true|false} Optional Boolean Policy Audit QDS section -pref-gated (enable.policy_audit + sub.enable.policy_report_score)
include_pa_report_trurisk={true|false} Optional Boolean Policy Audit TruRisk section - pref-gated (same as above)
include_framework_id={value} Optional String Framework ID selection

Input Parameters - STIG Template SettingsInput Parameters - STIG Template Settings

Key

Required / Optional

Data Type

Description
group.by={value} Optional String Default: 1. See Group By Variants for details
include_posture={value} Optional String Default: 1. Comma-separated posture IDs: 0=Non-compliant, 1=Compliant, 1000=Not Scored
include_severity={true|false} Optional String

Default: 1,2,3.

Severity values: 1: CAT I (High) , 2: CAT II (Medium) , 3: CAT III (Low)
include_host_stats={true|false} Optional Boolean Default: true. Host statistics section
include_rule_stats={true|false} Optional Boolean Default: true. Rule statistics section
include_report_details={true|false} Optional Boolean Default: true. Detailed report rows
include_glossary={true|false} Optional Boolean Default: true. Glossary section
include_appendix={true|false} Optional Boolean Default: true. Appendix section
network={true|false} Optional Boolean Default: true
evidence={true|false} Optional Boolean Default: true. Evidence
extended_evidence={true|false} Optional Boolean Default: true. Extended evidence
include_control_last_fail_date={true|false} Optional Boolean Last failure date
report_details={true|false} Optional Boolean Report details section
host_statistics={true|false} Optional Boolean Host statistics section
rule_statistics={true|false} Optional Boolean Rule statistics section
vuln_statistics={true|false} Optional Boolean Vuln statistics section
compliant_rule_stats_by_severity={true|false} Optional Boolean Compliant rule stats by severity
net_bios={true|false} Optional Boolean NetBIOS column
tracking_method={true|false} Optional Boolean Tracking method column
dns={true|false} Optional Boolean DNS column
operating_system={true|false} Optional Boolean Operating system column
instance={true|false} Optional Boolean Instance column
for_failed_control={true|false} Optional Boolean Include failed-control rows
for_passed_control={true|false} Optional Boolean Include passed-control rows
for_error_control Optional Boolean Include error-control rows
posture={true|false} Optional Boolean Posture toggle (distinct from include_posture CSV)
rule_description={true|false} Optional Boolean Rule description column
cci={true|false} Optional Boolean CCI column
rule_posture Optional Boolean Rule posture column
vuln_description Optional Boolean Vuln description column
vuln_posture={true|false} Optional Boolean Vuln posture column
glossary={true|false} Optional Boolean Glossary
appendix={true|false} Optional Boolean Appendix
exclude.account_id={true|false} Optional Boolean Exclude account ID from report
include.report.users={value} Optional String Comma-separated user IDs/usernames granted report access

Input Parameters - Mandate Template SettingsInput Parameters - Mandate Template Settings

Key

Required / Optional

Data Type

Description
group.by={value} Optional String Default: 1. Allowed: 1 (Mandate), 2 (Control Objective)
include_posture_status={value} Optional Integer Default: 0,1,2.  0-Fail, 1-Pass, 2-Error
include_control_criticality={value}
 Optional String

Control criticality filter. Supply include_control_criticality as a comma-separated string of numeric IDs

0 — Undefined

1 — Minimal

2 — Medium

3 — Serious

4 — Critical

5 — Urgent
include_mandate_stats={true|false} Optional Boolean Default: true. Mandate statistics section
include_report_details={true|false} Optional Boolean Default: true. Detailed report rows
include_glossary={true|false} Optional Boolean Default: true. Glossary section
include_appendix={true|false} Optional Boolean Default: true. Appendix section
graph.mandate={true|false} Optional Boolean Mandate graph
graph.requirement={true|false} Optional Boolean Requirement graph
graph.policy={true|false} Optional Boolean Policy graph
report.settings={true|false} Optional Boolean Report settings block
report.summary={true|false} Optional Boolean Report summary toggle
details={true|false} Optional Boolean Details toggle
control.posture={true|false} Optional Boolean Control posture
filter.policy.controls={true|false} Optional Boolean Filter by policy controls
include_custom_footer={true|false} Optional Boolean Enable custom footer section
custom.footer.text={value} Optional String Custom footer text - requires include_custom_footer: true
exclude.account_id={true|false} Optional Boolean Exclude account ID from report
report_settings={true|false} Optional Boolean Report settings block
include_report_summary={true|false} Optional Boolean Report summary section toggle
include_posture_graphs={true|false} Optional Boolean Posture graphs section toggle
glossary={true|false} Optional Boolean Glossary
appendix={true|false} Optional Boolean Appendix
include.report.users={value} Optional String Comma-separated user IDs/usernames granted report access

Input Parameters - Scorecard template SettingsInput Parameters - Scorecard template Settings

Key

Required / Optional

Data Type

Description
include_summary={true|false} Optional Boolean Report summary section
include_overall_by_policy={true|false} Optional Boolean Overall compliance grouped by policy
include_change_by_policy={true|false} Optional Boolean Change-over-time grouped by policy
include_change_by_policy_asset={true|false} Optional Boolean Change by policy, sub-grouped by asset group/tag
include_change_by_policy_tech={true|false} Optional Boolean Change by policy, sub-grouped by technology
include_overall_by_asset={true|false} Optional Boolean Overall compliance grouped by asset group/tag
include_change_by_asset={true|false} Optional Boolean Change-over-time grouped by asset group/tag
include_change_by_asset_policy={true|false} Optional Boolean Change by asset, sub-grouped by policy
include_change_by_asset_tech={true|false} Optional Boolean Change by asset, sub-grouped by technology
include_overall_by_tech={true|false} Optional Boolean Overall compliance grouped by technology
include_change_by_tech={true|false} Optional Boolean Change-over-time grouped by technology
include_top_host_change={true|false} Optional Boolean Top hosts with posture change
include_top_control_change={true|false} Optional Boolean Top controls with posture change
include_criticality={value} Optional String Control-criticality filter (requires subscription support)
include_fail_by_criticality={true|false} Optional Boolean Failures grouped by criticality (requires subscription support)
include_overall_by_criticality={true|false} Optional Boolean Overall compliance grouped by criticality
include_change_by_criticality={true|false} Optional Boolean Change-over-time grouped by criticality
include_change_by_criticality_policy={true|false} Optional Boolean Change by criticality, sub-grouped by policy
include_change_by_criticality_asset={true|false} Optional Boolean Change by criticality, sub-grouped by asset group/tag
include_change_by_criticality_tech={true|false} Optional Boolean Change by criticality, sub-grouped by technology
include_change_by_criticality_asc_order={true|false} Optional Boolean Sort criticality change ascending
include_change_by_criticality_desc_order={true|false} Optional Boolean Sort criticality change descending
include_failed_controls_by_criticality={true|false} Optional Boolean Failed controls grouped by criticality
compliance_scorecard_report_display={value} Optional Integer Top-N display count (default 10)
compliance_scorecard_report_timeframe={value} Optional Integer Trend timeframe in days, 1–90 (default 30)
compliance_scorecard_report_failed_controls_display={value} Optional Integer Top-N failed controls display count (default 5)
custom.footer.enabled={true|false} Optional Boolean Enable custom footer
custom.footer.text={value} Optional String Custom footer text
exclude.account_id={true|false} Optional Boolean Exclude account ID from report
include.report.users={value} Optional String Comma-separated user IDs/usernames granted report access

Input ParametersInput Parameters

Policy - report_group_by

Value

Description
group_by_hosts Group by host (default)
host Legacy alias for group_by_hosts
group_by_controls Group by control
group_by_control_references Group by control reference — requires pref pc.group_by_control_ref_policy_report
group_by_control_chaining Group by control chaining — requires pref pc.group_by_control_chaining_policy_report

Mandate - group.by

Value

Description
1 Group by Mandate (default)
2 Group by Control Objective

STIG - group.by

Value

Description
1 Group by Host based on STIG Rule (default) — see main Stig example above
2 Group by Host based on STIG Vuln
3 Group by STIG Rule
4 Group by STIG Vuln

Policy - report_group_by

Sample - Policy, Group By HostsSample - Policy, Group By Hosts

API Request

curl --location '<gateway_base_url>/pcrs/1.0/report/template' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer <JWT_Token>' \
--data '{
  "title": "My Policy Template",
  "type": "policy",
  "settings": {
        "report_group_by": "group_by_hosts",
        "report_sort_by": "sort_by_ip",
        "include_posture_status": "7",
        "include_report_summary": "true",
        "include_host_stats": "true",
        "include_report_details": "true",
        "include_control_rationale": "true",
        "include_control_evidence": "true",
        "include_control_ext_evidence": "true",
        "include_control_exceptions": "true",
        "include_exceptions_history": "true",
        "include_host_summary": "true",
        "include_appendix": "true",
        "include_control_scan_parameter": "true",
        "trend_duration": "30",
        "include_asset_tag": "true",
        "include_section_details": "false",
        "include_category_details": "false",
        "include_pa_report_trurisk": "false",
        "include_scan_source_details": "false",
        "include_control_previous_posture": "true",
        "include_failed_control_remediation": "true",
        "include_errored_control_remediation": "true",
        "include_control_not_expected_values": "true",
        "include_control_required_values": "true"
  }
}'

JSON Output

{
    "templateId": 4651203,
    "title": "My Policy Template",
    "type": "policy",
    "isGlobal": false,
    "owner": "quays_zd38",
    "createdAt": "2026-07-23T07:27:21Z",
    "settings": {
        "report_group_by": "group_by_hosts",
        "report_sort_by": "sort_by_ip",
        "include_posture_status": "7",
        "include_report_summary": "true",
        "include_host_stats": "true",
        "include_report_details": "true",
        "include_control_rationale": "true",
        "include_control_evidence": "true",
        "include_control_ext_evidence": "true",
        "include_control_exceptions": "true",
        "include_exceptions_history": "true",
        "include_host_summary": "true",
        "include_appendix": "true",
        "include_control_scan_parameter": "true",
        "trend_duration": "30",
        "include_asset_tag": "true",
        "include_section_details": "false",
        "include_category_details": "false",
        "include_pa_report_trurisk": "false",
        "include_scan_source_details": "false",
        "include_control_previous_posture": "true",
        "include_failed_control_remediation": "true",
        "include_errored_control_remediation": "true",
        "include_control_not_expected_values": "true",
        "include_control_required_values": "true"
    }
}

Sample - Policy, Group By ControlsSample - Policy, Group By Controls

API Request

curl --location '<gateway_base_url>/pcrs/1.0/report/template' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer <JWT_Token>' \
--data '{
  "title": "Policy Report Template - Group By Controls",
  "type": "policy",
  "settings": {
        "report_group_by": "group_by_controls",
        "report_sort_by": "sort_by_control_id",
        "include_posture_status": "7",
        "include_report_summary": "true",
        "include_report_details": "true",
        "include_control_summary": "true",
        "include_control_rationale": "true",
        "include_control_evidence": "true",
        "include_control_ext_evidence": "true",
        "include_control_exceptions": "true",
        "include_exceptions_history": "true",
        "include_appendix": "true",
        "include_control_scan_parameter": "true",
        "include_control_tech_summary": "true",
        "trend_duration": "30",
        "include_asset_tag": "true",
        "include_section_details": "false",
        "include_control_stats": "true",
        "include_control_comments": "true",
        "include_category_details": "false",
        "include_pa_report_trurisk": "false",
        "include_scan_source_details": "false",
        "include_control_previous_posture": "true",
        "include_failed_control_remediation": "true",
        "include_errored_control_remediation": "true",
        "include_control_not_expected_values": "true",
        "include_control_required_values": "true"
  }
}'

JSON Output

{
    "templateId": 4652132,
    "title": "Policy Report Template - Group By Controls",
    "type": "policy",
    "isGlobal": false,
    "owner": "quays_zd38",
    "createdAt": "2026-07-23T08:41:30Z",
    "settings": {
        "include_posture_status": "7",
        "include_report_summary": "true",
        "include_report_details": "true",
        "include_control_summary": "true",
        "include_control_rationale": "true",
        "include_control_evidence": "true",
        "include_control_ext_evidence": "true",
        "include_control_exceptions": "true",
        "include_exceptions_history": "true",
        "include_appendix": "true",
        "include_control_scan_parameter": "true",
        "include_control_tech_summary": "true",
        "report_group_by": "group_by_controls",
        "report_sort_by": "sort_by_control_id",
        "trend_duration": "30",
        "include_asset_tag": "true",
        "include_section_details": "false",
        "include_control_stats": "true",
        "include_control_comments": "true",
        "include_category_details": "false",
        "include_pa_report_trurisk": "false",
        "include_scan_source_details": "false",
        "include_control_previous_posture": "true",
        "include_failed_control_remediation": "true",
            }
}

Sample - Policy, Group By Control ReferencesSample - Policy, Group By Control References

API Request

curl --location '<gateway_base_url>/pcrs/1.0/report/template' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer <JWT_Token>' \
--data '{
  "title": "Policy Report Template - Group By Control References",
  "type": "policy",
  "settings": {
        "report_group_by": "group_by_control_references",
        "report_sort_by": "sort_by_control_id",
        "include_posture_status": "7",
        "include_report_summary": "true",
        "include_report_details": "true",
        "include_control_summary": "true",
        "include_control_rationale": "true",
        "include_control_evidence": "true",
        "include_control_ext_evidence": "true",
        "include_control_exceptions": "true",
        "include_exceptions_history": "true",
        "include_appendix": "true",
        "include_control_scan_parameter": "true",
        "include_control_tech_summary": "true",
        "trend_duration": "30",
        "include_host_stats": "true",
        "include_host_summary": "true",
        "include_control_stats": "false",
        "include_asset_tag": "true",
        "include_section_details": "false",
        "include_category_details": "false",
        "include_pa_report_trurisk": "false",
        "include_scan_source_details": "false",
        "include_control_previous_posture": "true",
        "include_failed_control_remediation": "true",
        "include_errored_control_remediation": "true",
        "include_control_not_expected_values": "true",
        "include_control_required_values": "true"
  }
}'

JSON Output

{
    "templateId": 4652134,
    "title": "Policy Report Template - Group By Control References",
    "type": "policy",
    "isGlobal": false,
    "owner": "username",
    "createdAt": "2026-07-23T08:44:36Z",
    "settings": {
        "report_group_by": "group_by_control_references",
        "report_sort_by": "sort_by_control_id",
        "include_posture_status": "7",
        "include_report_summary": "true",
        "include_report_details": "true",
        "include_control_summary": "true",
        "include_control_rationale": "true",
        "include_control_evidence": "true",
        "include_control_ext_evidence": "true",
        "include_control_exceptions": "true",
        "include_control_scan_parameter": "true",
        "include_control_tech_summary": "true",
        "trend_duration": "30",
        "include_host_stats": "true",
        "include_host_summary": "true",
        "include_control_stats": "false",
        "include_asset_tag": "true",
        "include_exceptions_history": "true",
        "include_appendix": "true",
        "include_section_details": "false",
        "include_category_details": "false",
        "include_pa_report_trurisk": "false",
        "include_scan_source_details": "false",
        "include_control_previous_posture": "true",
        "include_failed_control_remediation": "true",
        "include_errored_control_remediation": "true",
        "include_control_not_expected_values": "true",
        "include_control_required_values": "true"
    }
}

Sample - Policy, Group By Control ChainingSample - Policy, Group By Control Chaining

API Request

curl --location '<gateway_base_url>/pcrs/1.0/report/template' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer <JWT_Token>' \
--data '{
  "title": "Policy Report Template - Group By Control Chaining",
  "type": "policy",
  "settings": {
        "report_group_by": "group_by_control_chaining",
        "report_sort_by": "sort_by_ip",
        "include_posture_status": "7",
        "include_report_summary": "true",
        "include_host_stats": "true",
        "include_report_details": "true",
        "include_control_ext_evidence": "true",
        "include_control_scan_parameter": "true",
        "include_control_exceptions": "true",
        "include_exceptions_history": "true",
        "include_appendix": "true",
        "trend_duration": "30",
        "include_asset_tag": "true",
        "include_cloud_metadata": "false",
        "include_section_details": "false",
        "include_category_details": "false",
        "include_pa_report_trurisk": "false",
        "include_scan_source_details": "false",
        "include_host_summary": "true",
        "include_control_evidence": "true",
        "include_control_chaining_criticality": "true",
        "include_control_chaining_remediation": "true",
        "include_control_chaining_scoring": "true",
        "include_control_chaining_assessment_status": "true",
        "include_control_chaining_cis_audit_procedure": "true",
        "include_control_chaining_cis_remediation": "true",
        "include_control_chaining_ig_mapping": "true",
        "include_control_chaining_profile": "true",
        "include_control_not_expected_values": "true",
        "include_control_required_values": "true",
        "include_failed_control_remediation": "true",
        "include_errored_control_remediation": "true",
        "include_control_previous_posture": "true"
  }
}'

JSON Output

{
    "templateId": 4652136,
    "title": "Policy Report Template - Group By Control Chaining",
    "type": "policy",
    "isGlobal": false,
    "owner": "quays_zd38",
    "createdAt": "2026-07-23T08:54:17Z",
    "settings": {
        "report_group_by": "group_by_control_chaining",
        "report_sort_by": "sort_by_ip",
        "include_posture_status": "7",
        "include_report_summary": "true",
        "include_host_stats": "true",
        "include_report_details": "true",
        "include_host_summary": "true",
        "include_control_evidence": "true",
        "include_control_ext_evidence": "true",
        "include_control_scan_parameter": "true",
        "include_control_exceptions": "true",
        "include_exceptions_history": "true",
        "include_appendix": "true",
        "trend_duration": "30",
        "include_asset_tag": "true",
        "include_cloud_metadata": "false",
        "include_section_details": "false",
        "include_category_details": "false",
        "include_pa_report_trurisk": "false",
        "include_scan_source_details": "false",
        "include_control_chaining_criticality": "true",
        "include_control_chaining_remediation": "true",
        "include_control_chaining_scoring": "true",
        "include_control_chaining_assessment_status": "true",
        "include_control_chaining_cis_audit_procedure": "true",
        "include_control_chaining_cis_remediation": "true",
        "include_control_chaining_ig_mapping": "true",
        "include_control_chaining_profile": "true",
        "include_control_not_expected_values": "true",
        "include_control_required_values": "true",
        "include_failed_control_remediation": "true",
        "include_errored_control_remediation": "true",
        "include_control_previous_posture": "true"
    }
}

Mandate - Group.by

Sample - Mandate, Group By MandateSample - Mandate, Group By Mandate

API Request

curl --location '<gateway_base_url>/pcrs/1.0/report/template' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer <JWT_Token>' \
--data '{
  "title": "My Mandate Template",
  "type": "mandate",
  "isGlobal": true,
  "settings": {
        "filter.policy.controls": "true",
        "report.settings": "true",
        "report.summary": "true",
        "graph.mandate": "true",
        "graph.requirement": "true",
        "graph.policy": "true",
        "details": "true",
        "control.posture": "true",
        "glossary": "true",
        "include_posture_status": "0,1,2",
        "include_control_criticality": "0,1,2,3,4,5",
        "group.by": "1"
  }
}'

JSON Output

{
    "templateId": 4651201,
    "title": "My Mandate Template",
    "type": "mandate",
    "isGlobal": true,
    "owner": "quays_zd38",
    "createdAt": "2026-07-23T07:22:11Z",
    "settings": {
        "group.by": "1",
        "filter.policy.controls": "true",
        "report.settings": "true",
        "report.summary": "true",
        "graph.mandate": "true",
        "graph.requirement": "true",
        "graph.policy": "true",
        "details": "true",
        "control.posture": "true",
        "glossary": "true",
        "include_posture_status": "0,1,2",
        "include_control_criticality": "0,1,2,3,4,5"
    }
}

Sample - Mandate, Group By Control ObjectiveSample - Mandate, Group By Control Objective

API Request

curl --location '<gateway_base_url>/pcrs/1.0/report/template' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer <JWT_Token>' \
--data '{
  "title": "Mandate Report Template - Group By Control Objective",
  "type": "mandate",
  "isGlobal": true,
  "settings": {
        "group.by": "2",
        "filter.policy.controls": "true",
        "report.settings": "true",
        "report.summary": "true",
        "graph.mandate": "true",
        "graph.requirement": "true",
        "graph.policy": "true",
        "details": "true",
        "control.posture": "true",
        "glossary": "true",
        "include_posture_status": "0,1,2",
        "include_control_criticality": "0,1,2,3,4,5"
  }
}'

JSON Output

{
    "templateId": 4652138,
    "title": "Mandate Report Template - Group By Control Objective",
    "type": "mandate",
    "isGlobal": true,
    "owner": "quays_zd38",
    "createdAt": "2026-07-23T08:59:02Z",
    "settings": {
        "group.by": "2",
        "filter.policy.controls": "true",
        "report.settings": "true",
        "report.summary": "true",
        "graph.mandate": "true",
        "graph.requirement": "true",
        "graph.policy": "true",
        "details": "true",
        "control.posture": "true",
        "glossary": "true",
        "include_posture_status": "0,1,2",
        "include_control_criticality": "0,1,2,3,4,5"
    }
}

STIG - group.by

Sample - STIG, Group By Host based on STIG RuleSample - STIG, Group By Host based on STIG Rule

API Request

curl --location '<gateway_base_url>/pcrs/1.0/report/template' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer <JWT_Token>' \
--data '{
  "title": "My STIG Template",
  "type": "stig",
  "isGlobal": true,
  "settings": {
        "include_severity": "1,2,3",
        "rule_statistics": "true",
        "compliant_rule_stats_by_severity": "true",
        "report_details": "true",
        "host_statistics": "true",
        "net_bios": "true",
        "tracking_method": "true",
        "dns": "true",
        "operating_system": "true",
        "network": "true",
        "instance": "true",
        "for_passed_control": "true",
        "for_error_control": "true",
        "control_rationale": "true",
        "group.by": "1",
        "include_posture": "0,1,1000",
        "evidence": "true",
        "extended_evidence": "true",
        "for_failed_control": "true",
        "rule_description": "true",
        "rule_posture": "true",
        "cci": "true",
        "vuln_description": "true",
        "vuln_posture": "true",
        "glossary": "true",
        "appendix": "true"
  }
}'

JSON Output

{
    "templateId": 4651205,
    "title": "My STIG Template",
    "type": "stig",
    "isGlobal": true,
    "owner": "quays_zd38",
    "createdAt": "2026-07-23T07:35:34Z",
    "settings": {
        "group.by": "1",
        "include_posture": "0,1,1000",
        "include_severity": "1,2,3",
        "rule_statistics": "true",
        "compliant_rule_stats_by_severity": "true",
        "report_details": "true",
        "host_statistics": "true",
        "net_bios": "true",
        "tracking_method": "true",
        "dns": "true",
        "operating_system": "true",
        "network": "true",
        "instance": "true",
        "for_passed_control": "true",
        "for_error_control": "true",
        "control_rationale": "true",
        "evidence": "true",
        "extended_evidence": "true",
        "for_failed_control": "true",
        "rule_description": "true",
        "rule_posture": "true",
        "cci": "true",
        "vuln_description": "true",
        "vuln_posture": "true",
        "glossary": "true",
        "appendix": "true"
    }
}

Sample - STIG, Group By Host based on STIG VulnerabilitySample - STIG, Group By Host based on STIG Vulnerability

API Request

curl --location '<gateway_base_url>/pcrs/1.0/report/template' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer <JWT_Token>' \
--data '{
  "title": "Stig Report Template - Group By Host based on STIG Vuln",
  "type": "stig",
  "isGlobal": true,
  "settings": {
        "include_severity": "1,2,3",
        "rule_statistics": "true",
        "vuln_statistics": "true",
        "compliant_rule_stats_by_severity": "true",
        "report_details": "true",
        "host_statistics": "true",
        "net_bios": "true",
        "tracking_method": "true",
        "dns": "true",
        "operating_system": "true",
        "network": "true",
        "instance": "true",
        "for_passed_control": "true",
        "for_error_control": "true",
        "group.by": "2",
        "include_posture": "0,1,1000",
        "control_rationale": "true",
        "evidence": "true",
        "extended_evidence": "true",
        "for_failed_control": "true",
        "rule_description": "true",
        "rule_posture": "true",
        "cci": "true",
        "vuln_description": "true",
        "vuln_posture": "true",
        "glossary": "true",
        "appendix": "true"
  }
}'

JSON Output

{
    "templateId": 4652142,
    "title": "Stig Report Template - Group By Host based on STIG Vuln",
    "type": "stig",
    "isGlobal": true,
    "owner": "quays_zd38",
    "createdAt": "2026-07-23T09:11:03Z",
    "settings": {
        "group.by": "2",
        "include_posture": "0,1,1000",
        "include_severity": "1,2,3",
        "rule_statistics": "true",
        "vuln_statistics": "true",
        "compliant_rule_stats_by_severity": "true",
        "report_details": "true",
        "host_statistics": "true",
        "net_bios": "true",
        "tracking_method": "true",
        "dns": "true",
        "operating_system": "true",
        "network": "true",
        "instance": "true",
        "for_passed_control": "true",
        "for_error_control": "true",
        "control_rationale": "true",
        "evidence": "true",
        "extended_evidence": "true",
        "for_failed_control": "true",
        "rule_description": "true",
        "rule_posture": "true",
        "cci": "true",
        "vuln_description": "true",
        "vuln_posture": "true",
        "glossary": "true",
        "appendix": "true"
    }
}

Sample - STIG, Group By STIG RuleSample - STIG, Group By STIG Rule

API Request

curl --location '<gateway_base_url>/pcrs/1.0/report/template' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer <JWT_Token>' \
--data '{
  "title": "Stig Report Template - Group By Stig Rule",
  "type": "stig",
  "isGlobal": true,
  "settings": {
        "group.by": "3",
        "include_posture": "0,1,1000",
        "include_severity": "1,2,3",
        "rule_statistics": "true",
        "compliant_rule_stats_by_severity": "true",
        "report_details": "true",
        "host_statistics": "true",
        "net_bios": "true",
        "tracking_method": "true",
        "dns": "true",
        "operating_system": "true",
        "network": "true",
        "instance": "true",
        "for_passed_control": "true",
        "for_error_control": "true",
        "control_rationale": "true",
        "evidence": "true",
        "extended_evidence": "true",
        "for_failed_control": "true",
        "rule_description": "true",
        "rule_posture": "true",
        "cci": "true",
        "vuln_description": "true",
        "vuln_posture": "true",
        "glossary": "true",
        "appendix": "true"
  }
}'

JSON Output

{
    "templateId": 4653132,
    "title": "Stig Report Template - Group By Stig Rule",
    "type": "stig",
    "isGlobal": true,
    "owner": "quays_zd38",
    "createdAt": "2026-07-23T09:16:08Z",
    "settings": {
        "include_severity": "1,2,3",
        "rule_statistics": "true",
        "compliant_rule_stats_by_severity": "true",
        "report_details": "true",
        "host_statistics": "true",
        "net_bios": "true",
        "tracking_method": "true",
        "dns": "true",
        "operating_system": "true",
        "network": "true",
        "instance": "true",
        "for_passed_control": "true",
        "group.by": "3",
        "include_posture": "0,1,1000",
        "for_error_control": "true",
        "control_rationale": "true",
        "evidence": "true",
        "extended_evidence": "true",
        "for_failed_control": "true",
        "rule_description": "true",
        "rule_posture": "true",
        "cci": "true",
        "vuln_description": "true",
        "vuln_posture": "true",
        "glossary": "true",
        "appendix": "true"
    }
}

Sample - STIG, Group By STIG VulnerabilitySample - STIG, Group By STIG Vulnerability

API Request

curl --location '<gateway_base_url>/pcrs/1.0/report/template' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer <JWT_Token>' \
--data '{
  "title": "Stig Report Template - Group By Stig Vuln",
  "type": "stig",
  "isGlobal": true,
  "settings": {
        "include_posture": "0,1,1000",
        "include_severity": "1,2,3",
        "rule_statistics": "true",
        "vuln_statistics": "true",
        "compliant_rule_stats_by_severity": "true",
        "report_details": "true",
        "host_statistics": "true",
        "net_bios": "true",
        "tracking_method": "true",
        "dns": "true",
        "operating_system": "true",
        "network": "true",
        "instance": "true",
        "for_passed_control": "true",
        "group.by": "4",
        "for_error_control": "true",
        "control_rationale": "true",
        "evidence": "true",
        "extended_evidence": "true",
        "for_failed_control": "true",
        "rule_description": "true",
        "rule_posture": "true",
        "cci": "true",
        "vuln_description": "true",
        "vuln_posture": "true",
        "glossary": "true",
        "appendix": "true"
  }
}'

JSON Output

{
    "templateId": 4653134,
    "title": "Stig Report Template - Group By Stig Vuln",
    "type": "stig",
    "isGlobal": true,
    "owner": "quays_zd38",
    "createdAt": "2026-07-23T09:17:56Z",
    "settings": {
        "group.by": "4",
        "include_posture": "0,1,1000",
        "include_severity": "1,2,3",
        "rule_statistics": "true",
        "vuln_statistics": "true",
        "compliant_rule_stats_by_severity": "true",
        "report_details": "true",
        "host_statistics": "true",
        "net_bios": "true",
        "tracking_method": "true",
        "dns": "true",
        "operating_system": "true",
        "network": "true",
        "instance": "true",
        "for_passed_control": "true",
        "for_error_control": "true",
        "control_rationale": "true",
        "evidence": "true",
        "extended_evidence": "true",
        "for_failed_control": "true",
        "rule_description": "true",
        "rule_posture": "true",
        "cci": "true",
        "vuln_description": "true",
        "vuln_posture": "true",
        "glossary": "true",
        "appendix": "true"
    }
}

 

 

success Thank you! We're glad to hear that this topic was useful.
success We appreciate your feedback. We'll work to make this topic better for you in the future.