Create/Update/Reset Cloud Perimeter Scan
Click to view navigation pane


Create/Update/Reset Cloud Perimeter Scan

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

V2.0 | V3.0 | V4.0

V2.0

[POST]/api/2.0/fo/scan/cloud/perimeter/job/

We allow you to create/update a cloud perimeter scan job through Cloud Perimeter Scan API even if no scan targets are resolved from the provided details. At the time of scan, if no scan targets are resolved from the provided details, the scan will not be launched, and we add the error in the Activity log and Run history of the schedule scan job.

Cloud perimeter scans are available for VM and PC modules

Permissions- Only Managers and Unit Managers have permission to configure cloud perimeter scans.

Input ParametersInput Parameters

Click here to view parameters for launching Cloud Perimeter scans.

Sample - Create Cloud Perimeter Scan Job (Schedule Now)Sample - Create Cloud Perimeter Scan Job (Schedule Now)

API Request

curl -u "USERNAME:PASSWORD" -H "X-Requested-With: Curl""action=create&tag_set_by=name&tag_include_selector=any&tag_set_include=ec2-Virginia,Unassigned Business Unit&connector_name=conn1&region_code=us-east-1&active=1&option_title=Initial Options&module=vm&schedule=now&cloud_provider=aws&platform_type=classic&&after_notify=1&after_notify_message=Scan Finished" "https://qualysapi.qualys.com/api/2.0/fo/scan/cloud/perimeter/job/"

XML Output

<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE SIMPLE_RETURN SYSTEM "https://qualysapi.qualys.com/api/2.0/simple_return.dtd">
<SIMPLE_RETURN>
  <RESPONSE>
    <DATETIME>2018-04-11T04:06:01Z</DATETIME>
    <TEXT>Scan has been created successfully</TEXT>
    <ITEM_LIST>
      <ITEM>
        <KEY>ID</KEY>
        <VALUE>1352070</VALUE>
      </ITEM>
    </ITEM_LIST>
  </RESPONSE>
</SIMPLE_RETURN>

Sample - Create Cloud Perimeter Scan Job (Recurring Schedule)Sample - Create Cloud Perimeter Scan Job (Recurring Schedule)

API Request

curl -u "USERNAME:PASSWORD" -H "X-Requested-With: Curl""action=create&tag_set_by=name&tag_include_selector=any&tag_set_include=EC2_Targets&tag_exclude_selector=any&tag_set_exclude=EC2_Test&connector_name=EC2 Connector&region_code=us-east-1&active=0&occurrence=daily&start_date=04/02/2018&start_hour=10&start_minute=30&time_zone_code=IN&option_title=Initial Options&frequency_days=364&observe_dst=no&module=vm&schedule=recurring&cloud_provider=aws&platform_type=classic&after_notify=1&recipient_group_ids=4229" "https://qualysapi.qualys.com/api/2.0/fo/scan/cloud/perimeter/job/"

XML Output

<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE SIMPLE_RETURN SYSTEM "https://qualysapi.qualys.com/api/2.0/simple_return.dtd">
<SIMPLE_RETURN>
  <RESPONSE>
    <DATETIME>2018-04-11T05:01:42Z</DATETIME>
    <TEXT>Scan has been created successfully</TEXT>
    <ITEM_LIST>
      <ITEM>
        <KEY>ID</KEY>
        <VALUE>1352071</VALUE>
      </ITEM>
    </ITEM_LIST>
  </RESPONSE>
</SIMPLE_RETURN>

Sample - Update Cloud Perimeter Scan JobSample - Update Cloud Perimeter Scan Job

API Request

curl -u "USERNAME:PASSWORD" -H "X-Requested-With: Curl""action=update&id=1352071&connector_name=EC2Connector-2&platform_type=vpc_peered&region_code=us-west-1" "https://qualysapi.qualys.com/api/2.0/fo/scan/cloud/perimeter/job/"

XML Output

<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE SIMPLE_RETURN SYSTEM "https://qualysapi.qualys.com/api/2.0/simple_return.dtd">
<SIMPLE_RETURN>
  <RESPONSE>
    <DATETIME>2018-04-11T05:05:35Z</DATETIME>
    <TEXT>Scan has been updated successfully</TEXT>
    <ITEM_LIST>
      <ITEM>
        <KEY>ID</KEY>
        <VALUE>1352071</VALUE>
      </ITEM>
    </ITEM_LIST>
  </RESPONSE>
</SIMPLE_RETURN>

DTD

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

 

V3.0

[POST]/api/3.0/fo/scan/cloud/perimeter/job/

We allow you to create/update a cloud perimeter scan job through Cloud Perimeter Scan API even if no scan targets are resolved from the provided details. At the time of scan, if no scan targets are resolved from the provided details, the scan will not be launched, and we add the error in the Activity log and Run history of the schedule scan job.

Cloud perimeter scans are available for VM and PC modules.

Permissions - Only Managers and Unit Managers have permission to configure cloud perimeter scans.

Input ParametersInput Parameters

Click here to view parameters for launching Cloud Perimeter scans.

Sample - Create Cloud Perimeter Scan JobSample - Create Cloud Perimeter Scan Job

API Request

curl --location --request POST 'https://<qualys_base_url>/api/3.0/fo/scan/cloud/perimeter/job/?action=create&scan_title=API%20Launch17&configured_from_source=connector_module&source_scan_type=custom&module=vm&active=1&schedule=now&option_title=Initial%20Options&priority=1&cloud_provider=azure&cloud_service=vm&connector_uuid=5fdec014-0562-47fc-8029-a90e7d87add9&include_lb_from_connector=1&include_app_gateway_lb_from_connector=1' \
--header 'X-Requested-With: curl demo2' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Authorization: Basic dm1zcF9hZzE6UXVhbHlzQDEyMw=='

XML Output

<?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-13T06:12:28Z</DATETIME>
        <TEXT>Scan has been created successfully</TEXT>
        <ITEM_LIST>
            <ITEM>
                <KEY>ID</KEY>
                <VALUE>1431330</VALUE>
            </ITEM>
        </ITEM_LIST>
    </RESPONSE>
</SIMPLE_RETURN>


Sample - Update Cloud Perimeter Scan JobSample - Update Cloud Perimeter Scan Job

API Request

curl --location --request POST 'https://<qualys_base_url>/api/3.0/fo/scan/cloud/perimeter/job/?action=update&id=1431330&priority=1&connector_uuid=5fdec014-0562-47fc-8029-a90e7d87add9&include_lb_from_connector=1&include_app_gateway_lb_from_connector=1' \
--header 'X-Requested-With: curl demo2' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Authorization: Basic dm1zcF9hZzE6UXVhbHlzQDEyMw=='

XML Output

<?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-13T06:30:25Z</DATETIME>
        <TEXT>Scan has been updated successfully</TEXT>
        <ITEM_LIST>
            <ITEM>
                <KEY>ID</KEY>
                <VALUE>1431330</VALUE>
            </ITEM>
        </ITEM_LIST>
    </RESPONSE>
</SIMPLE_RETURN>

DTD

<platform API server>/api/2.0/simplYou can now reset the scheduled scan's pause/cancel and recurrence scheduling settings for cloud perimeter scans.e_return.dtd

V4.0

[POST]/api/4.0/fo/scan/cloud/perimeter/job/

We allow you to create/update a cloud perimeter scan job through Cloud Perimeter Scan API even if no scan targets are resolved from the provided details. At the time of scan, if no scan targets are resolved from the provided details, the scan will not be launched, and we add the error in the Activity log and Run history of the schedule scan job. 
You can now reset the scheduled scan's pause/cancel and recurrence scheduling settings for cloud perimeter scans.

Cloud perimeter scans are available for VM and PC modules.

Permissions - Only Managers and Unit Managers have permission to configure cloud perimeter scans.

Input ParametersInput Parameters

Click here to view parameters for launching Cloud Perimeter scans.

Sample - Create Cloud Perimeter Scan JobSample - Create Cloud Perimeter Scan Job

API Request

curl --location --request POST 'https://<qualys_base_url>/api/4.0/fo/scan/cloud/perimeter/job/?action=create&scan_title=API%20Launch17&configured_from_source=connector_module&source_scan_type=custom&module=vm&active=1&schedule=now&option_title=Initial%20Options&priority=1&cloud_provider=azure&cloud_service=vm&connector_uuid=5fdec014-0562-47fc-8029-a90e7d87add9&include_lb_from_connector=1&include_app_gateway_lb_from_connector=1' \
--header 'X-Requested-With: curl demo2' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Authorization: Basic dm1zcF9hZzE6UXVhbHlzQDEyMw=='

XML Output

<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE SIMPLE_RETURN SYSTEM "https://<qualys_base_url>/api/4.0/simple_return.dtd">
<SIMPLE_RETURN>
    <RESPONSE>
        <DATETIME>2025-03-13T06:12:28Z</DATETIME>
        <TEXT>Scan has been created successfully</TEXT>
        <ITEM_LIST>
            <ITEM>
                <KEY>ID</KEY>
                <VALUE>1431330</VALUE>
            </ITEM>
        </ITEM_LIST>
    </RESPONSE>
</SIMPLE_RETURN>


Sample - Update Cloud Perimeter Scan JobSample - Update Cloud Perimeter Scan Job

API Request

curl --location --request POST 'https://<qualys_base_url>/api/4.0/fo/scan/cloud/perimeter/job/?action=update&id=1431330&priority=1&connector_uuid=5fdec014-0562-47fc-8029-a90e7d87add9&include_lb_from_connector=1&include_app_gateway_lb_from_connector=1' \
--header 'X-Requested-With: curl demo2' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Authorization: Basic dm1zcF9hZzE6UXVhbHlzQDEyMw=='

XML Output

<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE SIMPLE_RETURN SYSTEM "https://<qualys_base_url>/api/4.0/simple_return.dtd">
<SIMPLE_RETURN>
    <RESPONSE>
        <DATETIME>2025-03-13T06:30:25Z</DATETIME>
        <TEXT>Scan has been updated successfully</TEXT>
        <ITEM_LIST>
            <ITEM>
                <KEY>ID</KEY>
                <VALUE>1431330</VALUE>
            </ITEM>
        </ITEM_LIST>
    </RESPONSE>
</SIMPLE_RETURN>

Sample - Reset the scheduled scan duration and recurrenceSample - Reset the scheduled scan duration and recurrence

API Request

curl --location --request POST '
<qualys_base_url>/api/4.0/fo/scan/cloud/perimeter/job/index.php?`action=update&id=1458384&active=1&remove_duration=1&remove_recurrence=1' \
--header 'X-Requested-With: postman' \
--header 'Authorization: Basic Encoded username:passwordstring'

XML Output

<?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-17T09:41:09Z</DATETIME>
        <TEXT>Scan has been updated successfully</TEXT>
        <ITEM_LIST>
            <ITEM>
                <KEY>ID</KEY>
                <VALUE>1458384</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/scan/cloud/perimeter/job/

Active

Active

/api/3.0/fo/scan/cloud/perimeter/job/

December 2025

June 2026

/api/2.0/fo/scan/cloud/perimeter/job/

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.