Get Activation Key Details

[GET] [POST] /qps/rest/1.0/get/ca/agentactkey/<id>

Returns details on a selected activation key in the user’s account.

Where “id” (Required) is the activation key ID of interest. We have added support for new Qualys application — Mitigation.

Permissions required - Managers with full scope. Other users must have these permissions: Access Permission “API Access” and CA Activation Key Permission “View Activation Key”.

Input ParametersInput Parameters

There are no input parameters.

Sample - View details on activation keySample - View details on activation key

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/25002"

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>25002</id>
            <activationKey>dc5e51f9-89de-47e2-ad3526d5ee0f865d</activationKey>
            <status>ACTIVE</status>
            <countPurchased>0</countPurchased>
            <countUsed>0</countUsed>
            <datePurchased>2015-10-05T23:05:42Z</datePurchased>
            <type>UNLIMITED</type>
            <isDisabled>false</isDisabled>
            <modules>
                <list>
                    <ActivationKeyModule>
                       <license>VM_LICENSE</license>
                    </ActivationKeyModule>
                </list>
            </modules>
            <tags>
                <list>
                    <Tag>
                        <id>522325</id>
                        <name>Temp Tag</name>
                    </Tag>
                </list>
            </tags>
            <agents>
                <list/>
            </agents>
            <ownerId>364812443</ownerId>
        </AgentActKey>
    </data>
</ServiceResponse>

XSD

<platform API server>/qps/xsd/1.0/ca/agentactkey.xsd