For API version information, refer to the API Version History section.
Cancel a running report in the user's account.
Permissions - Managers can cancel any running report. Unit Managers can cancel running report in their own business unit (report launched by users in their own business unit). Scanners can cancel their own report.
|
Parameter |
Required/Optional |
Data Type |
Description |
|---|---|---|---|
|
action=cancel |
Required |
String |
Specify action to cancel report. |
|
echo_request={0|1} |
Optional |
Integer |
Specify 1 to view (echo) input parameters in the XML output. By default these are not included. |
|
id={value} |
Required |
Integer |
The report ID you want to take action on. |
API Request
curl -H "X-Requested-With: Curl Sample"-d "action=cancel;id=1462"-b "QualysSession=71e6cda2a35d2cd404cddaf305ea0208; path=/api; secure" "<qualys_base_url>/api/2.0/fo/report/"<platform API server>/api/2.0/simple_return.dtd
Cancel a running report in the user's account.
Permissions - Managers can cancel any running report. Unit Managers can cancel running report in their own business unit (report launched by users in their own business unit). Scanners can cancel their own report.
|
Parameter |
Required/Optional |
Data Type |
Description |
|---|---|---|---|
|
action=cancel |
Required |
String |
Specify action to cancel report. |
|
echo_request={0|1} |
Optional |
Integer |
Specify 1 to view (echo) input parameters in the XML output. By default these are not included. |
|
id={value} |
Required |
Integer |
The report ID you want to take action on. |
API Request
curl --location --request POST '<qualys_base_url>/api/3.0/fo/report/?echo_request=1&action=cancel&id=6619731' \
--header 'X-Requested-With: curl' \
--header 'Authorization: Basic Encoded username:passwordstring'
XML Output
<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE SIMPLE_RETURN SYSTEM "
<qualys_base_url>/api/3.0/simple_return.dtd">
<SIMPLE_RETURN>
<REQUEST>
<DATETIME>2025-06-17T11:05:51Z</DATETIME>
<USER_LOGIN>akkqa_tq</USER_LOGIN>
<RESOURCE>
<qualys_base_url>/api/3.0/fo/report/
</RESOURCE>
<PARAM_LIST>
<PARAM>
<KEY>echo_request</KEY>
<VALUE>1</VALUE>
</PARAM>
<PARAM>
<KEY>action</KEY>
<VALUE>cancel</VALUE>
</PARAM>
<PARAM>
<KEY>id</KEY>
<VALUE>6627719</VALUE>
</PARAM>
</PARAM_LIST>
</REQUEST>
<RESPONSE>
<DATETIME>2025-06-17T11:05:51Z</DATETIME>
<TEXT>Report canceled</TEXT>
<ITEM_LIST>
<ITEM>
<KEY>ID</KEY>
<VALUE>6627719</VALUE>
</ITEM>
</ITEM_LIST>
</RESPONSE>
</SIMPLE_RETURN>
<platform API server>/api/3.0/simple_return.dtd
The following table depicts the information about the different versions of this API along with the status:
| API Version | EOS | EOL |
| /api/3.0/fo/report/?action=cancel | Active | Active |
| /api/2.0/fo/report/?action=cancel | December 2025 |
June 2026 |