Create/Update Azure Internal Scan

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

We allow you to create/update a Azure internal scan job through Azure Internal 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.

Azure internal scans are available for only VM modules.

Permissions- Only Managers and Unit Managers and Scanners user role  have permission to configure Azure cloud internal scans.

Input ParametersInput Parameters

Click here to view the parameters for launching Azure Internal scans.

Sample - Create an Azure Internal scan jobSample - Create an Azure Internal scan job

API Request`

curl --location --request POST '<qualys_base_url>/api/2.0/fo/scan/
cloud/internal/job/index.php?action=create&scan_title=Azure%20Scan%20Internal%20Test&
connector_uuid=1abcd111-1111-11ab-1111-a11b111aaa1&active=1&
option_title=Initial%20Options&
module=vm&schedule=now&cloud_provider=azure&iscanner_name=Azure_Internal_Scanner_vmsp_ag1&`
region_code=eastus&priority=2&
platform_type=location&cloud_service=vm' \
--header 'X-Requested-With: xxxx' \
--header 'User-Agent: agentname/1.1.1 (https://agentname.com)' \
--header 'Authorization: encoded username:passwordstring' \
--header 'Accept: */*' \
--header 'Host: <qualys_base_url>' \
--header 'Connection: keep-alive'

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>2024-11-26T05:17:19Z</DATETIME>
        <TEXT>Scan has been created successfully</TEXT>
        <ITEM_LIST>
            <ITEM>
                <KEY>ID</KEY>
                <VALUE>1395111</VALUE>
            </ITEM>
        </ITEM_LIST>
    </RESPONSE>
</SIMPLE_RETURN>        

Sample - Update an Azure Internal Scan jobSample - Update an Azure Internal Scan job

API Request

curl --location --request POST '<qualys_base_url>/api/2.0/fo/scan/cloud/
internal/job/index.php?action=update&
scan_title=Updated%20scan%20name&id=1395111&
iscanner_name=Azure_Internal_Scanner_New' \
--header 'X-Requested-With: qweabu' \
--header 'User-Agent: agentname/1.1.1 (https://agentname.com)' \
--header 'Authorization: encoded username:password string' \
--header 'Accept: */*' \
--header 'Host: <qualys_base_url>' \
--header 'Connection: keep-alive'

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>2024-11-26T05:20:01Z</DATETIME>
        <TEXT>Scan has been updated successfully</TEXT>
        <ITEM_LIST>
            <ITEM>
                <KEY>ID</KEY>
                <VALUE>1395111</VALUE>
            </ITEM>
        </ITEM_LIST>
    </RESPONSE>
</SIMPLE_RETURN>       

DTD

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


 

 

Was this topic helpful?

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.