Create Scan Template

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

V2.0|V3.0|V4.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 "<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 "<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

API Request

curl --location '<qualys_base_url> /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 "
<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

V4.0

POST /api/4.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 --location --request POST '<qualys_base_url>/api/4.0/fo/report/template/scan/?action=create&report_format=xml' \
--header 'Accept: */*' \
--header 'X-Requested-With: curl' \
--header 'content-type: text/xml' \
--header 'Authorization: Basic encoded username:passwordstring'

XML Response

<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE SIMPLE_RETURN SYSTEM "<qualys_base_url>/api/4.0/simple_return.dtd">
<SIMPLE_RETURN>
    <RESPONSE>
        <DATETIME>2025-06-17T04:57:23Z</DATETIME>
        <TEXT>Scan Report Template(s) Successfully Created.</TEXT>
        <ITEM_LIST>
            <ITEM>
                <KEY>ID</KEY>
                <VALUE>8737800</VALUE>
            </ITEM>
        </ITEM_LIST>
    </RESPONSE>
</SIMPLE_RETURN>

 

DTD

 

<platform API server>/api/4.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 EOS EOL
/api/4.0/fo/report/template/scan/?action=create Active Active
/api/3.0/fo/report/template/scan/?action=create December 2025

June 2026

/api/2.0/fo/report/template/scan/?action=create December 2025 June 2026

 

 

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.