Release 3.19.1 API

November 06, 2024

Before understanding the API release highlights, learn more about the API server URL to be used in your API requests by referring to the Know Your Qualys API Server URL section. For this API Release Notes, <qualys_base_url> is mentioned in the sample API requests.

What's New?

Cloud Agent

Software Component Report Download API: Support to Download SwCA Scan Report as per Cyclone Dx Standard in JSON Format

New or Updated API New
API Endpoint /qps/rest/1.0/download/ca/downloadcdxsbom/
Method POST
DTD or XSD Changes Not Applicable

With this API, we added support for downloading Software Composition Analysis (SwCA) Scan Report as per CycloneDX standard in JSON format. You can either view the SwCA scan report or download it.

Input ParametersInput Parameters

Use the following input parameters to generate the SwCA report as per Cyclon Dx standard in JSON format.

Input Parametr Mandatory/ Optional Data Type Description
assetId Mandatory Integer Use this parameter to specify the unique asset ID.
cdxschemaversion Mandatory String Use this parameter to specify the report version you want to download Acceptable values: CYCLONE_DX_1_4, CYCLONE_DX_1_6

Sample: Download SwCA Scan ReportSample: Download SwCA Scan Report

The following sample demonstrates downloading the SwCA scan report as per CycloneDX standard in JSON format.

API Request

curl -u fo_username:password -X POST -H "application/xml" 
-H "X-Requested-With: curl" --data-binary @download_report.xml 
"<qualys_base_url>/qps/rest/1.0/download/ca/downloadcdxsbom/"

 API Request Body

<?xml version="1.0" encoding="UTF-8"?>
<ServiceRequest>
    <data>
        <DownloadCDXSbom>
            <assetId>12345678</assetId>
            <cdxschemaversion>CYCLONE_DX_1_6</cdxschemaversion>
        </DownloadCDXSbom>
    </data>
</ServiceRequest> 
 

API Response

   SwCA report will be downloaded with Status: 200 OK

Added Support for New Qualys Application ‒ Mitigation

With this release, we have added support for a new Qualys application - Mitigation. You can now enable the Qualys Mitigation for your Cloud Agents and launch the mitigation jobs for the vulnerabilities detected on your assets. This helps you minimize the risks associated with the vulnerabilities for which the patches are not available or can not be deployed due to system unavailability.

With the introduction of Qualys Mitigation, we have updated the following Cloud Agent APIs to help you manage the Mitigation applications. Using these APIs, you can activate or deactivate Qualys Mitigation for single or multiple Cloud Agents, create an activation key and provision it, update an existing activation key to provision it for Qualys Mitigation, and fetch activation key details.

This feature is available only for Cloud Agent binaries with support for Qualys Mitigation. To learn more about supported Cloud Agent versions, refer to the Cloud Agent Platform Availability Matrix.

Activate Single Agent API: Activate Single Agent for Qualys MitigationActivate Single Agent API: Activate Single Agent for Qualys Mitigation

New or Updated API Updated
API Endpoint /qps/rest/2.0/activate/am/asset/<id>?module=<value1>,<value2>
Method POST
DTD or XSD Changes No

Using this API, you can activate the Qualys applications for a single Cloud Agent. With this release, we have added support to activate the new Qualys Application ‒ Mitigation for a single Cloud Agent.

Provide the following details in the API Request:

Query Parameter Description
<id> (Required) Provide the asset ID of the Cloud Agent you want to activate.
module=<value1>,<value2> (Required) Provide the application names that you want to activate for a Cloud Agent. The applications you want to activate must be enabled for your subscription. You can provide multiple application names to be activated for a Cloud Agent in a comma-separated list. Use AGENT_MTG for Qualys Mitigation.

Sample: Activate Single Agent for Qualys MitigationSample: Activate Single Agent for Qualys Mitigation

The following is the sample of activating a single Cloud Agent for Mitigation.

API Request

      
curl -u fo_username:password -X POST -H "Content-Type: text/xml" -H 
"X-Requested-With: curl" --data-binary @single_activation.xml"
<qualys_base_url>/qps/rest/2.0/activate/am/asset/1234567?module=AGENT_MTG" 
      
      

API Request Body

      
<?xml version="1.0" encoding="UTF-8" ?>
<ServiceRequest></ServiceRequest>
      
      

API 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>1234567</id>
			<name>abcd1234efg5</name>
			<created>2024-06-22T11:45:38Z</created>
			<modified>2024-07-21T21:14:26Z</modified>
			<type>HOST</type>
			<tags>
				<list>
					<TagSimple>
						<id>1234567</id>
						<name>Tag name 1</name>
					</TagSimple>
					<TagSimple>
						<id>2345678</id>
						<name>Tag name 2</name>
					</TagSimple>
					<TagSimple>
						<id>3456789</id>
						<name>Cloud Agent</name>
					</TagSimple>
					<TagSimple>
						<id>4567891</id>
						<name>Tag name 3</name>
					</TagSimple>
					<TagSimple>
						<id>5678912</id>
						<name>Tag name 4</name>
					</TagSimple>
				</list>
			</tags>
			<sourceInfo>
				<list>
					<AssetSource/>
				</list>
			</sourceInfo>
		</Asset>
	</data>
</ServiceResponse>
      
      

Activate Multiple Agents API: Activate Multiple Agents for Qualys MitigationActivate Multiple Agents API: Activate Multiple Agents for Qualys Mitigation

New or Updated API Updated
API Endpoint /qps/rest/2.0/activate/am/asset?module=<value1>,<value2>
Method POST
DTD or XSD Changes No

Using this API, you can activate multiple Cloud Agents for Qualys applications. With this release, we are introducing support to activate the new Qualys Application ‒ Mitigation for multiple Cloud Agents.

Provide the following details in the API request:

Query Parameter Description
module=<value1>,<value2> (Required) Provide the application names that you want to activate for a Cloud Agent. The applications you want to activate must be enabled for your subscription.

You can provide multiple application names to be activated for a Cloud Agent in a comma-separated list. Use AGENT_MTG for Qualys Mitigation.

Input ParametersInput Parameters

Use the following <ServiceRequest> parameters to select the Cloud Agents you want to activate. These parameters act as filters. When multiple filters are specified, parameters are combined using a logical AND.

Parameter Mandatory/ Optional Data Type Description
id Optional Long Asset ID of the agent host.
name Optional String Asset name of the agent host.
created Optional Date The date when the agent host was added to your asset inventory (i.e. when the agent was provisioned).

The date is specified in UTC/GMT format, i.e. YYYY-MM-DD[THH:MM:SSZ]
updated Optional Date The date when the agent was last updated, such as activation, hostname change, etc. The date is specified in UTC/GMT format.
tagName Optional String The asset tag name assigned to the agent host. All agent hosts are assigned the tag Cloud Agent.

Sample: Activate Multiple Cloud Agents for MitigationSample: Activate Multiple Cloud Agents for Mitigation

API Request

      
curl -u fo_username:password -X POST -H "Content-Type: text/xml" -H 
"Cache-Control: no-cache" --data-binary @activate_all_agents.xml
"<qualys_base_url>/qps/rest/2.0/activate/am/asset?module=AGENT_MTG"
     
     

API Request Body

      
<?xml version="1.0" encoding="UTF-8" ?>
<ServiceRequest>
	<filters>
		<Criteria field="tagName" operator="EQUALS">Cloud Agent</Criteria>
	</filters>
</ServiceRequest>
      
      

API 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>3</count>
    <data>
        <Asset>
            <id>123456</id>
            <name>123.123.1.12</name>
            <created>2024-06-18T16:54:50Z</created>
            <modified>2024-06-18T16:54:51Z</modified>
            <type>HOST</type>
            <tags>
                <list>
                    <TagSimple>
                        <id>123456</id>
                        <name>Cloud Agent</name>
                    </TagSimple>
                </list>
            </tags>
            <sourceInfo>
                <list>
                    <AssetSource/>
                </list>
            </sourceInfo>
        </Asset>
        <Asset>
            <id>2532638</id>
            <name>12.12.1.123</name>
            <created>2024-04-17T13:32:48Z</created>
            <modified>2024-05-14T14:06:03Z</modified>
            <type>HOST</type>
            <tags>
                <list>
                    <TagSimple>
                        <id>123456</id>
                        <name>Cloud Agent</name>
                    </TagSimple>
                </list>
            </tags>
            <sourceInfo>
                <list>
                    <AssetSource/>
                </list>
            </sourceInfo>
        </Asset>
        <Asset>
            <id>1234567</id>
            <name>local IP agent</name>
            <created>2024-04-19T13:52:08Z</created>
            <modified>2024-07-05T12:26:48Z</modified>
            <type>HOST</type>
            <tags>
                <list>
                    <TagSimple>
                        <id>123467</id>
                        <name>Cloud Agent</name>
                    </TagSimple>
                    <TagSimple>
                        <id>123456</id>
                        <name>Agent</name>
                    </TagSimple>
                </list>
            </tags>
            <sourceInfo>
                <list>
                    <AssetSource/>
                </list>
            </sourceInfo>
        </Asset>
    </data>
</ServiceResponse>
      
      

Deactivate Single Agent API: Deactivate Single Agent for Qualys MitigationDeactivate Single Agent API: Deactivate Single Agent for Qualys Mitigation

New or Updated API Updated
API Endpoint /qps/rest/2.0/deactivate/am/asset/<id>?module=<value1>,<value2>
Method POST
DTD or XSD Changes No

Using this API, you can deactivate the Qualys applications for a single Cloud Agent. With this release, we are introducing support to deactivate the new Qualys Application ‒ Mitigation for a single Cloud Agent.

Provide the following details in the API Request:

Query Parameter Description
<id> (Required) Provide the asset ID of the Cloud Agent you want to deactivate. 
module=<value1>,<value2> (Required) Provide the application name that you want to deactivate for a Cloud Agent. The applications you want to deactivate must be enabled for your subscription. You can provide multiple application names to be deactivated for a Cloud Agent in a comma-separated list. Use AGENT_MTG for Qualys Mitigation.

Sample: Deactivate a single Cloud Agent for MitigationSample: Deactivate a single Cloud Agent for Mitigation

API Request

      
curl -u fo_username:password -X POST -H "Content-Type: text/xml" --
data-binary @single_deactivation.xml 
"
<qualys_base_url>/qps/rest/2.0/deactivate/am/asset/12345678
?module=AGENT_MTG"
     
     

API Request Body

      
<?xml version="1.0" encoding="UTF-8" ?>
<ServiceRequest></ServiceRequest>
     
     

API 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>1234567</id>
                <name>123456-A123</name>
                <created>2024-04-12T07:23:41Z</created>
                <modified>2024-04-19T07:07:12Z</modified>
                <type>HOST</type>
                <tags>
                    <list>
                        <TagSimple>
                            <id>1234567</id>
                            <name>Cloud Agent</name>
                        </TagSimple>
                    </list>
                </tags>
                <sourceInfo>
                    <list>
                        <AssetSource/>
                    </list>
                </sourceInfo>
            </Asset>
        </data>
    </ServiceResponse>
</ServiceResponse>
     
     

Deactivate Multiple Agents API: Deactivate Multiple Agents for Qualys MitigationDeactivate Multiple Agents API: Deactivate Multiple Agents for Qualys Mitigation

New or Updated API Updated
API Endpoint /qps/rest/2.0/deactivate/am/asset?module=<value1>,<value2>
Method POST
DTD or XSD Changes No

Using this API, you can deactivate the Qualys applications for multiple Cloud Agents. With this release, we are introducing support to deactivate the new Qualys Application ‒ Mitigation for multiple Cloud Agents.

Provide the following details in the API Request:

Query Parameter Description
<id> (Required) Provide the asset ID of the Cloud Agent you want to deactivate. 
module=<value1>,<value2> (Required) Provide the application names that you want to deactivate for a Cloud Agent. The applications you want to deactivate must be enabled for your subscription. You can provide multiple application names to be deactivated for a Cloud Agent in a comma-separated list. Use AGENT_MTG for Qualys Mitigation.

Input ParametersInput Parameters

Use the following <ServiceRequest> parameters to select the Cloud Agents you want to deactivate. These parameters act as filters. When multiple filters are specified, parameters are combined using a logical AND.

Parameter Manadatory/ Optional Data Type Description
id Optional Long Asset ID of the agent host.
name Optional String Asset name of the agent host.
created Optional Date     The date when the agent host was added to your inventory.

The date is specified in UTC/GMT format, i.e. YYYY-MM-DD[THH:MM:SSZ]
updated Optional Date The date when the agent was last updated, such as activation, hostname change, etc. The date is specified in UTC/GMT format.
tagName Optional String The asset tag name assigned to the agent host. All agent hosts are assigned the tag Cloud Agent.

Sample: Deactivate Multiple Agents for MitigationSample: Deactivate Multiple Agents for Mitigation

 The following is the sample API request for deactivating multiple Cloud Agents for Mitigation.

API Request

      
curl -u fo_username:password -X POST -H "Content-Type: text/xml" --data-binary@single_deactivation.xml"
<qualys_base_url>/qps/rest/2.0/deactivate/am/asset/1234567?module=AGENT_MTG" 
      
      

API Request Body

      
<?xml version="1.0" encoding="UTF-8" ?>
<ServiceRequest></ServiceRequest>
      
      

API 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>1234567</id>
				<name>123456-A123</name>
				<created>2024-04-12T07:23:41Z</created>
				<modified>2024-04-19T07:07:12Z</modified>
				<type>HOST</type>
				<tags>
					<list>
						<TagSimple>
							<id>1234567</id>
							<name>Cloud Agent</name>
						</TagSimple>
					</list>
				</tags>
				<sourceInfo>
					<list>
						<AssetSource/>
					</list>
				</sourceInfo>
			</Asset>
		</data>
	</ServiceResponse>
</ServiceResponse>
      
      

Create Activation Key API: Create Activation Key for Qualys MitigationCreate Activation Key API: Create Activation Key for Qualys Mitigation

New or Updated API Updated
API Endpoint /qps/rest/1.0/create/ca/agentactkey/
Method POST
DTD or XSD Changes No

Using this API, you can create an activation key and use it for provisioning Cloud Agents to different Qualys Applications. With this release, we are adding the support to provision a Cloud Agent using an activation key for the new Qualys Application ‒ Mitigation.

Input ParametersInput Parameters

The <ServiceRequest> parameters are used to create an activation key. You can use the filter operators with <ServiceRequest> parameters.

Parameters Mandatory/Optional Data Type Description
type Mandatory String Defines activation key type.
Valid values: UNLIMITED, 
COUNT_LIMITED, TIME_LIMITED, 
COUNT_TIME_LIMITED
countPurchased Optional Integer Number of activation keys purchased. 
This is a mandatory paramer if activation key type is COUNT_LIMITED or COUNT_TIME_LIMITED.
Value>=1
expireDate Optional Date Activation key expiration date.
The date is specified in UTC/GMT format, i.e. YYYY-MMDD[THH:MM:SS.
This is a mandatory parameter if the activation key type is TIME_LIMITED or COUNT_TIME_LIMITED.
modules Optional String Defines the modules to be activated for an activation key.
Use MTG for Qualys Mitigation.
tags Optional String Defines the tags added to an activation key.
These tags are added to Cloud Agents installed with this activation key.

Sample: Create Activation Key for MitigationSample: Create Activation Key for Mitigation

API Request


curl -X POST -H "Content-Type: text/xml" -H "X-Requested-With: curl" -
H "Authorization: Basic AbcdAbcdAbcdAbcdAbcd" -H "Cxml" -H 
"Cache-Control: no-cache" --data-binary @key_create.xml 
"<qualys_base_url>/qps/rest/1.0/create/ca/agentactkey/"

API Request Body

      
<?xml version="1.0" encoding="UTF-8"?>
<ServiceRequest>
    <data>
        <AgentActKey>
            <title>example create from api</title>
            <countPurchased>0</countPurchased>
            <expireDate>2024-12-05T23:05:42Z</expireDate>
            <type>UNLIMITED</type>
            <ownerId>123456789</ownerId>
            <modules>
                <list>
                    <ActivationKeyModule>
                        <license>MTG</license>
                    </ActivationKeyModule>
                </list>
            </modules>
            <tags>
                <list>
                    <Tag>
                        <id>123456</id>
                        <name>Temp Tag</name>
                    </Tag>
                </list>
            </tags>
        </AgentActKey>
    </data>
</ServiceRequest>
      
      

API Request


<?xml version="1.0" encoding="UTF-8"?>
<ServiceResponse
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
xsi:noNamespaceSchemaLocation="<qualys_base_url>/qps/xsd/1.
0/ca/agentactkey.xsd">
    <responseCode>SUCCESS</responseCode>
    <count>1</count>
    <data>
        <AgentActKey>
            <id>59001</id>
            <activationKey>123ab4cd-6ef7-89g1-ab1c-d2345678-ef9g</activationKey>
            <status>ACTIVE</status>
            <countPurchased>0</countPurchased>
            <countUsed>0</countUsed>
            <datePurchased>2024-09-07T14:48:15Z</datePurchased>
            <type>UNLIMITED</type>
            <title>example key create from api</title>
            <isDisabled>false</isDisabled>
            <modules>
                <list>
                    <ActivationKeyModule>
                        <license>MTG</license>
                    </ActivationKeyModule>
                </list>
            </modules>
            <tags>
                <list>
                    <Tag>
                        <id>123456</id>
                        <name>Temp Tag</name>
                    </Tag>
                </list>
            </tags>
            <ownerId>123456789</ownerId>
        </AgentActKey>
    </data>
</ServiceResponse>

Update Activation Key API: Update Activation Key for Qualys MitigationUpdate Activation Key API: Update Activation Key for Qualys Mitigation

New or Updated API Updated
API Endpoint /qps/rest/1.0/update/ca/agentactkey/<id>
Method POST
DTD or XSD Changes No

Using this API, you can update activation keys. With this release, we are adding support to provision a Cloud Agent using an activation key for the new Qualys Application ‒ Mitigation.

Input ParametersInput Parameters

The following <ServiceRequest> parameters are used to update an activation key. Filter operators are available for use with <ServiceRequest> parameters.

Parameter Mandatory/ Optional Data Type Description
id Mandatory Integer The ID of an activation key to be updated.
type Mandatory String Specify the key type.

Valid values:  UNLIMITED, COUNT_LIMITED, TIME_LIMITED, COUNT_TIME_LIMITED
countPurchased Manadatory Integer Specify the number of keys you have purchased.

(This parameter is mandatory if you specify the key type as COUNT_LIMITED or COUNT_TIME_LIMITED). Valid values >= 1.
expireDate Manadatory Date Specify the key expiration date. Date is specified in UTC/GMT format, i.e. YYYY-MM-DD[THH:MM:SSZ.

This parameter is mandatory if you specify the key type as TIME_LIMITED or COUNT_TIME_LIMITED.
modules Optional String Provision one or more modules for this key.

Use MTG for Mitigation.
tags Optional String Add tags to this key. These tags are applied to the agents installed with the key.
isDisabled Optional Boolean Set this parameter to true to disable an activation key.
applyOnAgents Optional Boolean Set this parameter to true to apply the updated key to all associated Cloud Agents.

The changes related to tags, licenses, and limits are applied to Cloud Agents.

By default, this parameter is false, meaning updated activation key changes are not applied to Cloud Agents.

Sample: Update an Activation Key for Qualys MitigationSample: Update an Activation Key for Qualys Mitigation

API Request


curl -X POST -H "X-Requested-With: curl" -H "Authorization: Basic 
AbcdAbcdAbcdAbcdAbcd" -H "Content-Type: text/xml" -H "Cache-Control: 
no-cache" --data-binary @key_update.xml 
"<qualys_base_url>/qps/rest/1.0/update/ca/agentactkey/1234"

API Request Body

      
<?xml version="1.0" encoding="UTF-8"?>
<ServiceResponse
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
xsi:noNamespaceSchemaLocation="<qualys_base_url>/qps/xsd/1.
0/ca/agentactkey.xsd">
    <responseCode>SUCCESS</responseCode>
    <count>1</count>
    <data>
        <AgentActKey>
            <id>6201</id>
            <title>example key updated from api</title>
            <activationKey>123ab4cd-6ef7-89g1-ab1c-d2345678-ef9g</activationKey>
            <status>ACTIVE</status>
            <countPurchased>0</countPurchased>
            <countUsed>0</countUsed>
            <datePurchased>2024-09-07T14:48:15Z</datePurchased>
            <type>UNLIMITED</type>
            <title>example key create from api</title>
            <isDisabled>false</isDisabled>
            <applyOnAgents>true</applyOnAgents>
            <modules>
                <list>
                    <ActivationKeyModule>
                        <license>VM_LICENSE</license>
                    </ActivationKeyModule>
                    <ActivationKeyModule>
                        <license>PC_LICENSE</license>
                    </ActivationKeyModule>
                    <ActivationKeyModule>
                        <license>MTG</license>
                    </ActivationKeyModule>
                </list>
            </modules>
            <tags>
                <list>
                    <Tag>
                        <id>123456</id>
                        <name>Temp Tag</name>
                    </Tag>
                </list>
            </tags>
            <ownerId>123456789</ownerId>
        </AgentActKey>
    </data>
</ServiceResponse>
      

API 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/1.
0/ca/agentactkey.xsd">
    <responseCode>SUCCESS</responseCode>
    <count>1</count>
    <data>
        <AgentActKey>
            <id>1234</id>
            <title>example key updated from api</title>
            <activationKey>123ab4cd-6ef7-89g1-ab1c-d2345678-ef9g</activationKey>
            <status>ACTIVE</status>
            <countPurchased>0</countPurchased>
            <countUsed>0</countUsed>
            <datePurchased>2024-09-07T14:48:15Z</datePurchased>
            <type>UNLIMITED</type>
            <title>example key create from api</title>
            <isDisabled>false</isDisabled>
            <applyOnAgents>true</applyOnAgents>
            <modules>
                <list>
                    <ActivationKeyModule>
                        <license>VM_LICENSE</license>
                    </ActivationKeyModule>
                    <ActivationKeyModule>
                        <license>PC_LICENSE</license>
                    </ActivationKeyModule>
                    <ActivationKeyModule>
                        <license>MTG</license>
                    </ActivationKeyModule>
                </list>
            </modules>
            <tags>
                <list>
                    <Tag>
                        <id>123456</id>
                        <name>Temp Tag</name>
                    </Tag>
                </list>
            </tags>
            <ownerId>123456789</ownerId>
        </AgentActKey>
    </data>
</ServiceResponse>
      

Get Activation Key Details API: View Activation Key DetailGet Activation Key Details API: View Activation Key Detail

New or Updated API Updated
API Endpoint /qps/rest/1.0/get/ca/agentactkey/<id>
Method GET, POST
DTD or XSD Changes No

Using this API, you can view activation key details such as key iID status, unique activation key, key purchased and used counts, type, and provisioned applications. With this release, we are adding support for a new Qualys application ‒ Mitigation.

To get the details of an activation key, specify the activation key ID (id) in the API request.

Sample: View Activation Key DetailsSample: View Activation Key Details

API Request


curl -X GET -H "X-Requested-With: curl" -H "Authorization: Basic 
AbcdAbcdAbcdAbcdAbcd" -H "Cache-Control: no-cache" 
"<qualys_base_url>/qps/rest/1.0/get/ca/agentactkey/12345"

API 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/1.0/ca/agentactkey.xsd">
    <responseCode>SUCCESS</responseCode>
    <count>1</count>
    <data>
        <AgentActKey>
            <id>12345</id>
            <activationKey>123ab4cd-6ef7-89g1-ab1c-d2345678ef9g</activationKey>
            <status>ACTIVE</status>
            <countPurchased>0</countPurchased>
            <countUsed>0</countUsed>
            <datePurchased>2024-10-05T23:05:42Z</datePurchased>
            <type>UNLIMITED</type>
            <isDisabled>false</isDisabled>
            <modules>
                <list>
                    <ActivationKeyModule>
                        <license>VM_LICENSE</license>
                    </ActivationKeyModule>
                    <ActivationKeyModule>
                        <license>PC_LICENSE</license>
                    </ActivationKeyModule>
                    <ActivationKeyModule>
                        <license>MTG</license>
                    </ActivationKeyModule>
                </list>
            </modules>
            <tags>
                <list>
                    <Tag>
                        <id>123456</id>
                        <name>Temp Tag</name>
                    </Tag>
                </list>
            </tags>
            <agents>
                <list/>
            </agents>
            <ownerId>123456789</ownerId>
        </AgentActKey>
    </data>
</ServiceResponse>
      

To learn more about impacted APIs, refer to Qualys Cloud Agent API User Guide.