Create/Update Cloud Perimeter Scan

Click here to view parameters for launching Cloud Perimeter scans.

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>

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>

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>

Click here to view parameters for launching Cloud Perimeter scans.

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>

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>