Export Scan Template

GET /api/2.0/fo/report/template/scan/?action=export

Export a scan report template to XML format.

Input ParametersInput Parameters

Parameter

Required/Optional

Data
Type

Description

action=export

Required

String

Specify action=export to export all scan templates

report_format=xml

Required

File

Specify to export scan template in xml format

template_id={value}

Optional

Integer

The template ID you want to take action on.

When not specified all templates for the report type will be exported.

Sample - Export Scan TemplateSample - Export Scan Template

API Request

curl -u "USERNAME:PASSWORD" -H "X-Requested-With:curl" "https://<qualys_base_url>/api/2.0/fo/report/template/scan/?action=export&template_id=89470&report_format=xml"

XML Output

<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE REPORTTEMPLATE SYSTEM "https://<qualys_base_url>/api/2.0/fo/report/template/scan/scanreporttemplate_info.dtd">
<REPORTTEMPLATE>
  <SCANTEMPLATE>
    <TITLE>
      <INFO key="title"><![CDATA[Scan-Report-To-Create-Do not Change]]></INFO>
      <INFO key="owner"><![CDATA[1086]]></INFO>
    </TITLE>
    <TARGET>
      <INFO key="scan_selection"><![CDATA[HostBased]]></INFO>
      <INFO key="include_trending"><![CDATA[1]]></INFO>
      <INFO key="selection_type"><![CDATA[days]]></INFO>
      <INFO key="selection_range"><![CDATA[5]]></INFO>
      <INFO key="limit_timeframe"><![CDATA[1]]></INFO>
      <INFO key="asset_groups"><![CDATA[PBPS-Targets]]></INFO>
      <INFO key="tag_set_by"><![CDATA[id]]></INFO>
      <INFO key="tag_set_include"><![CDATA[8644659]]></INFO>
      <INFO key="tag_set_exclude"><![CDATA[8262228]]></INFO>
      <INFO key="tag_include_selector"><![CDATA[ALL]]></INFO>
      <INFO key="tag_exclude_selector"><![CDATA[ALL]]></INFO>
      <INFO key="network"><![CDATA[-100]]></INFO>
      <INFO key="ips"><![CDATA[10.10.0.1,10.10.0.5]]></INFO>
      <INFO key="host_with_cloud_agents"><![CDATA[all]]></INFO>
    </TARGET>
    <DISPLAY>
      <INFO key="graph_business_risk"><![CDATA[1]]></INFO>
      <INFO key="graph_vuln_over_time"><![CDATA[1]]></INFO>
      <INFO key="display_text_summary"><![CDATA[1]]></INFO>
      <INFO key="graph_status"><![CDATA[1]]></INFO>
      <INFO key="graph_potential_status"><![CDATA[1]]></INFO>
      <INFO key="graph_severity"><![CDATA[1]]></INFO>
      <INFO key="graph_potential_severity"><![CDATA[1]]></INFO>
      <INFO key="graph_ig_severity"><![CDATA[1]]></INFO>
      <INFO key="graph_top_categories"><![CDATA[1]]></INFO>
      <INFO key="graph_top_vulns"><![CDATA[1]]></INFO>
      <INFO key="graph_os"><![CDATA[1]]></INFO>
      <INFO key="graph_services"><![CDATA[1]]></INFO>
      <INFO key="graph_top_ports"><![CDATA[1]]></INFO>
      <INFO key="display_custom_footer"><![CDATA[1]]></INFO>
      <INFO key="display_custom_footer_text"><![CDATA[Test@123]]></INFO>
      <INFO key="sort_by"><![CDATA[host]]></INFO>
      <INFO key="cvss"><![CDATA[all]]></INFO>
      <INFO key="host_details"><![CDATA[0]]></INFO>
      <INFO key="qualys_system_ids"><![CDATA[1]]></INFO>
      <INFO key="include_text_summary"><![CDATA[1]]></INFO>
      <INFO key="include_vuln_details"><![CDATA[1]]></INFO>
      <INFO key="include_vuln_details_threat"><![CDATA[1]]></INFO>
      <INFO key="include_vuln_details_impact"><![CDATA[1]]></INFO>
      <INFO key="include_vuln_details_solution"><![CDATA[1]]></INFO>
      <INFO key="include_vuln_details_vpatch"><![CDATA[1]]></INFO>
      <INFO key="include_vuln_details_compliance"><![CDATA[1]]></INFO>
      <INFO key="include_vuln_details_exploit"><![CDATA[1]]></INFO>
      <INFO key="include_vuln_details_malware"><![CDATA[1]]></INFO>
      <INFO key="include_vuln_details_results"><![CDATA[1]]></INFO>
      <INFO key="include_vuln_details_appendix"><![CDATA[1]]></INFO>
      <INFO key="exclude_account_id"><![CDATA[1]]></INFO>
      <INFO key="include_vuln_details_reopened"><![CDATA[1]]></INFO>
      <INFO key="metadata_ec2_instances"><![CDATA[0]]></INFO>
    </DISPLAY>
    <FILTER>
      <INFO key="selective_vulns"><![CDATA[complete]]></INFO>
      <INFO key="search_list_ids"><![CDATA[]]></INFO>
      <INFO key="exclude_qid_option"><![CDATA[1]]></INFO>
      <INFO key="exclude_search_list_ids"><![CDATA[]]></INFO>
      <INFO key="included_os"><![CDATA[ALL]]></INFO>
      <INFO key="status_new"><![CDATA[1]]></INFO>
      <INFO key="status_active"><![CDATA[1]]></INFO>
      <INFO key="status_reopen"><![CDATA[1]]></INFO>
      <INFO key="status_fixed"><![CDATA[1]]></INFO>
      <INFO key="vuln_active"><![CDATA[1]]></INFO>
      <INFO key="vuln_disabled"><![CDATA[1]]></INFO>
      <INFO key="vuln_ignored"><![CDATA[1]]></INFO>
      <INFO key="potential_active"><![CDATA[1]]></INFO>
      <INFO key="potential_disabled"><![CDATA[1]]></INFO>
      <INFO key="potential_ignored"><![CDATA[1]]></INFO>
      <INFO key="ig_active"><![CDATA[1]]></INFO>
      <INFO key="ig_disabled"><![CDATA[1]]></INFO>
      <INFO key="ig_ignored"><![CDATA[0]]></INFO>
      <INFO key="display_non_running_kernels"><![CDATA[1]]></INFO>
      <INFO key="exclude_non_running_kernel"><![CDATA[0]]></INFO>
      <INFO key="exclude_non_running_services"><![CDATA[1]]></INFO>
      <INFO key="exclude_superceded_patches"><![CDATA[1]]></INFO>
      <INFO key="exclude_qids_not_exploitable_due_to_configuration"><![CDATA[1]]></INFO>
      <INFO key="categories_list"><![CDATA[ALL]]></INFO>
    </FILTER>
    <SERVICESPORTS>
      <INFO key="required_services"><![CDATA[ActiveSync,akak trojan,Apple
       Airport Management,Applix TM1 Server]]></INFO>
      <INFO key="unauthorized_services"><![CDATA[aml,Arkeiad Network
       Backup,auth]]></INFO>
      <INFO key="services_info"><![CDATA[aml,Arkeiad Network
       Backup,auth]]></INFO>
      <INFO key="required_ports"><![CDATA[12]]></INFO>
      <INFO key="unauthorized_ports"><![CDATA[21]]></INFO>
    </SERVICESPORTS>
    <USERACCESS>
      <INFO
       key="report_access_users"><![CDATA[start_rm2,start_su]]></INFO>
      <INFO key="global"><![CDATA[1]]></INFO>
    </USERACCESS>
  </SCANTEMPLATE>
</REPORTTEMPLATE>

DTD

<platform API server>/api/2.0/fo/report/template/scan/scanreporttemplate_info.dtd