Activate Asset

[POST] /qps/rest/2.0/activate/am/asset/<id>?module=QWEB_VM

[ POST] /qps/rest/2.0/activate/am/asset?module=QWEB_VM

[POST] /qps/rest/2.0/activate/am/asset/<id>?module=QWEB_PC

[POST] /qps/rest/2.0/activate/am/asset?module=QWEB_PC

[POST] /qps/rest/2.0/activate/am/asset/<id>?module=QWEB_SCA

[POST] /qps/rest/2.0/activate/am/asset?module=QWEB_SCA

[POST] /qps/rest/2.0/activate/am/asset/<id>?module=CERTVIEW

[POST] /qps/rest/2.0/activate/am/asset?module=CERTVIEW

Activate one or more assets to make them available in your account for scanning and reporting. You’ll want to activate newly created hosts to make them available in the Vulnerability Management (VM) module, Policy Compliance (PC) module, Security Configuration Assessment (SCA) module, or CertView module.

Permissions required - Users with full scope. Other users must have requested assets in their scope and Access Permission “API Access”.

Input ParametersInput Parameters

Click here for available operators

Parameter	Mandatory /Optional	Data Type	Description
id	Optional	integer
name	Optional	text
created	Optional	date
updated	Optional	date
type	Optional	keyword	UNKOWN, HOST, SCANNER, WEBAPP, MALWARE_DOMAIN
tagName	Optional	text	Parent tags of the tag will also match
tagId	Optional	text	Parent tags of the tag will also match

Sample - Activate assets with the tag “Export to VM”Sample - Activate assets with the tag “Export to VM”

API request

curl -u "USERNAME:PASSWORD" -H "content-type: text/xml" -X "POST" --data-binary @- "<qualys_base_url>/qps/rest/2.0/activate/am/asset?module=QWEB_VM" < file.xml
Note: “file.xml” contains the request POST data.

Request POST data

<ServiceRequest>
    <filters>
        <Criteria field="tagName" operator="EQUALS">Export to VM</Criteria>
    </filters>
</ServiceRequest>

Response

<?xml version="1.0" encoding="UTF-8"?>
<ServiceResponse
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="<qualys_base_url>/qps/xsd/2.0/am/asset.xsd">
    <responseCode>SUCCESS</responseCode>
    <count>1</count>
    <data>
        <Asset>
            <id>1972521</id>
            <name>Test Asset</name>
            <created>2013-12-11T05:12:45Z</created>
            <modified>2014-02-04T23:55:54Z</modified>
            <type>HOST</type>
            <tags>
                <list>
                    <SimpleTag>
                        <id>12345</id>
                        <name>Export to VM</name>
                    </SimpleTag>
                    <list>
                    </tags>
                    <sourceInfo>
                        <list>
                            <Ec2AssetSourceSimple>
                                <firstDiscovered>2014-02-06T19:14:50Z</firstDiscovered>
                                <lastUpdated>2014-02-06T19:14:50Z</lastUpdated>
                                <assetId>1972521</assetId>
                                <availabilityZone>us-east</availabilityZone>
                                <privateDnsName>ip-10-90-0-73.qualys.com</privateDnsName>
                                <instanceId>i-8b545eef</instanceId>
                                <instanceType>t1.micro</instanceType>
                                <imageId>ami-03ad6e6a</imageId>
                                <privateIpAddress>127.0.0.1</privateIpAddress>
                                <monitoringEnabled>false</monitoringEnabled>
                            </Ec2AssetSourceSimple>
                        </list>
                    </sourceInfo>
                    <openPort>
                        <list/>
                    </openPort>
                    <software>
                        <list/>
                    </software>
                    <vuln>
                        <list/>
                    </vuln>
                </Asset>
            </data>
        </ServiceResponse>

Sample - Activate assets for PC moduleSample - Activate assets for PC module

API request

curl -u "USERNAME:PASSWORD" -H "content-type: text/xml" -X "POST" --data-binary @- "<qualys_base_url>/qps/rest/2.0/activate/am/asset?module=QWEB_VM" < file.xml
Note: “file.xml” contains the request POST data.

Request POST data

<ServiceRequest>
    <filters>
        <Criteria field="state" operator="EQUALS">DEALLOCATED</Criteria>
    </filters>
</ServiceRequest>

Response

<?xml version="1.0" encoding="UTF-8"?>
<ServiceResponse
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="<qualys_base_url>/qps/xsd/2.0/am/asset.xsd">
    <responseCode>SUCCESS</responseCode>
    <count>1</count>
    <data>
        <Asset>
            <id>15057806</id>
            <name>asset_for_pc</name>
            <created>2020-07-01T00:04:04Z</created>
            <modified>2020-07-26T00:07:26Z</modified>
            <type>HOST</type>
            <tags>
                <list>
                    <TagSimple>
                        <id>110494212</id>
                        <name>Azure-static-tag</name>
                    </TagSimple>
                </list>
            </tags>
            <sourceInfo>
                <list>
                    <AzureAssetSourceSimple>
                        <assetId>15057806</assetId>
                        <type>AZURE</type>
                        <firstDiscovered>2020-07-01T00:04:07Z</firstDiscovered>
                        <lastUpdated>2020-07-25T22:59:59Z</lastUpdated>
                        <name>asset_for_pc</name>
                        <location>eastus</location>
                        <vmSize>Standard_A1</vmSize>
                        <vmId>ffc23409-2433-4ca7-b832-033ef231f235</vmId>
                        <offer>CentOS</offer>
                        <state>DEALLOCATED</state>
                        <publisher>OpenLogic</publisher>
                        <version>latest</version>
                        <osType>Linux</osType>
                        <subnet>subnet-2849</subnet>
                        <subscriptionId>XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX</subscriptionId>
                        <resourceGroupName>DefaultResourceGroup-EUS</resourceGroupName>
                        <macAddress>00-0D-3A-54-1B-AA</macAddress>
                        <privateIpAddress>10.95.0.158</privateIpAddress>
                    </AzureAssetSourceSimple>
                </list>
            </sourceInfo>
        </Asset>
    </data>
</ServiceResponse>

Sample - Activate assets for SCA moduleSample - Activate assets for SCA module

API request

curl -u "USERNAME:PASSWORD" -H "content-type: text/xml" -X "POST" --data-binary @- "<qualys_base_url>/qps/rest/2.0/activate/am/asset?module=QWEB_SCA" < file.xml
Note: “file.xml” contains the request POST data.

Request POST data

<ServiceRequest>
    <filters>
        <Criteria field="vmId" operator="EQUALS">ffc23409-2433-4ca7-b832-033ef231f235</Criteria>
    </filters>
</ServiceRequest>

Response

<?xml version="1.0" encoding="UTF-8"?>
<ServiceResponse
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="<qualys_base_url>/qps/xsd/2.0/am/asset.xsd">
    <responseCode>SUCCESS</responseCode>
    <count>1</count>
    <data>
        <Asset>
            <id>15057806</id>
            <name>sample_azure_asset</name>
            <created>2020-07-01T00:04:04Z</created>
            <modified>2020-07-26T00:09:27Z</modified>
            <type>HOST</type>
            <tags>
                <list>
                    <TagSimple>
                        <id>110494212</id>
                        <name>Azure-static-tag</name>
                    </TagSimple>
                </list>
            </tags>
            <sourceInfo>
                <list>
                    <AzureAssetSourceSimple>
                        <assetId>15057806</assetId>
                        <type>AZURE</type>
                        <firstDiscovered>2020-07-01T00:04:07Z</firstDiscovered>
                        <lastUpdated>2020-07-25T22:59:59Z</lastUpdated>
                        <name>sample_azure_asset</name>
                        <location>eastus</location>
                        <vmSize>Standard_A1</vmSize>
                        <vmId>ffc23409-2433-4ca7-b832-033ef231f235</vmId>
                        <offer>CentOS</offer>
                        <state>DEALLOCATED</state>
                        <publisher>OpenLogic</publisher>
                        <version>latest</version>
                        <osType>Linux</osType>
                        <subnet>subnet-2849</subnet>
                        <subscriptionId>XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX</subscriptionId>
                        <resourceGroupName>DefaultResourceGroup-EUS</resourceGroupName>
                        <macAddress>00-0D-3A-54-1B-AA</macAddress>
                        <privateIpAddress>10.95.0.158</privateIpAddress>
                    </AzureAssetSourceSimple>
                </list>
            </sourceInfo>
        </Asset>
    </data>
</ServiceResponse>

Sample - Activate assets for CertView moduleSample - Activate assets for CertView module

API request

curl -u "USERNAME:PASSWORD" -H "content-type: text/xml" -X "POST" --data-binary @- "<qualys_base_url>/qps/rest/2.0/activate/am/asset/15057806?module=CERTVIEW" < file.xml
Note: “file.xml” contains the request POST data.

Request POST data

<ServiceRequest>
    <filters>
        <Criteria field="tagName" operator="EQUALS">activation_test_tag    
        </filters>
    </ServiceRequest>

Response

<?xml version="1.0" encoding="UTF-8"?>
<ServiceResponse
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="<qualys_base_url>/qps/xsd/2.0/am/asset.xsd">
    <responseCode>SUCCESS</responseCode>
    <count>1</count>
    <data>
        <Asset>
            <id>15057806</id>
            <name>Sample_asset</name>
            <created>2020-07-01T00:04:04Z</created>
            <modified>2020-07-26T00:11:16Z</modified>
            <type>HOST</type>
            <tags>
                <list>
                    <TagSimple>
                        <id>110878225</id>
                        <name>activation_test_tag</name>
                    </TagSimple>
                    <TagSimple>
                        <id>110494212</id>
                        <name>Azure-static-tag</name>
                    </TagSimple>
                </list>
            </tags>
            <sourceInfo>
                <list>
                    <AzureAssetSourceSimple>
                        <assetId>15057806</assetId>
                        <type>AZURE</type>
                        <firstDiscovered>2020-07-01T00:04:07Z</firstDiscovered>
                        <lastUpdated>2020-07-25T22:59:59Z</lastUpdated>
                        <name>Sample_asset</name>
                        <location>eastus</location>
                        <vmSize>Standard_A1</vmSize>
                        <vmId>ffc23409-2433-4ca7-b832-033ef231f235</vmId>
                        <offer>CentOS</offer>
                        <state>DEALLOCATED</state>
                        <publisher>OpenLogic</publisher>
                        <version>latest</version>
                        <osType>Linux</osType>
                        <subnet>subnet-2849</subnet>
                        <subscriptionId>XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX</subscriptionId>
                        <resourceGroupName>DefaultResourceGroup-EUS</resourceGroupName>
                        <macAddress>00-0D-3A-54-1B-AA</macAddress>
                        <privateIpAddress>10.95.0.158</privateIpAddress>
                    </AzureAssetSourceSimple>
                </list>
            </sourceInfo>
        </Asset>
    </data>
</ServiceResponse>

XSD

<platform API server>/qps/xsd/2.0/am/asset.xsd