Create Scan Template

For API version information, refer to the API Version History section.

V2.0|V3.0

V2.0

POST /api/2.0/fo/report/template/scan/?action=create

Create a scan report template in the user's account.

Input ParametersInput Parameters

Click here to view parameters for creating scan templates.

Sample - Create Scan TemplateSample - Create Scan Template

API Request

curl -u "USERNAME:PASSWORD" -H "X-Requested-With:curl" -X POST -H "Content-type: text/xml" --data-binary @scan_export.xml "https://<qualys_base_url>/api/2.0/fo/report/template/scan/?action=create&report_format=xml"

XML Output

<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE SIMPLE_RETURN SYSTEM "https://<qualys_base_url>/api/2.0/simple_return.dtd">
<SIMPLE_RETURN>
  <RESPONSE>
    <DATETIME>2017-04-06T05:41:32Z</DATETIME>
    <CODE>Scan Report Template(s) Created Successfully [89876]</CODE>
    <TEXT></TEXT>
  </RESPONSE>
</SIMPLE_RETURN>

DTD

<platform API server>/api/2.0/simple_return.dtd

V3.0

POST /api/3.0/fo/report/template/scan/?action=create

Create a scan report template in the user's account.

Input ParametersInput Parameters

Click here to view parameters for creating scan templates.

Sample - Create Scan TemplateSample - Create Scan Template

XML Output

curl --location 'https:// /api/3.0/fo/report/template/scan/?action=create&report_format=xml' \
--header 'X-Requested-With: curl' \
--header 'Content-Type: text/xml' \
--header 'Authorization: encoded username:passwordstring' \
--data '

XML Response

<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE SIMPLE_RETURN SYSTEM "https://
<qualys_base_url>/api/3.0/simple_return.dtd">
    <SIMPLE_RETURN>
        <RESPONSE>
            <DATETIME>2025-03-04T06:04:28Z</DATETIME>
            <TEXT>Scan Report Template(s) Successfully Created.</TEXT>
            <ITEM_LIST>
                <ITEM>
                    <KEY>ID</KEY>
                    <VALUE>3038061</VALUE>
                </ITEM>
            </ITEM_LIST>
        </RESPONSE>
    </SIMPLE_RETURN>

DTD

<platform API server>/api/3.0/simple_return.dtd

API Version History

The following table depicts the information about the different versions of this API along with the status:

API Version API Status Release Date
/api/2.0/fo/report/template/scan/?action=create To be Deprecated September 2025
/api/3.0/fo/report/template/scan/?action=create Active

March 2025