Activation Key APIs
With the activation key APIs, you can create, update, search, and delete the activation keys.
The following are the two broad categories of the Activation Key APIs.
Legacy Activation Key API: The legacy activation key API are available for the Legacy Cloud Agent user interface.
New Activation Key API: The new activation key APIs are available for the new Cloud Agent application user interface. You must have the Cloud Agent application 2.4.0 or later versions to access these API.
The following table maps the legacy activation key APIs with the new activation key APIs.
| API Name | Legacy API Endpoint | New API Endpoint | Description |
|---|---|---|---|
| Get Activation Key Details API | [GET] [POST] /qps/rest/1.0/get/ca/agentactkey/<id> | [GET] /caui/v1/activation-keys/manage/<id> | Use this API to get activation key details. |
| Search Activation Key API | [POST] /qps/rest/1.0/search/ca/agentactkey/ | [POST] /caui/v1/activation-keys/manage | Use this API to search activation keys. |
| Create Activation Key API | [POST] /qps/rest/1.0/create/ca/agentactkey/ | [POST] /caui/v1/activation-keys/manage/activation-key | Use this API to create a new activation key. |
| Update Activation Key API | [POST] /qps/rest/1.0/update/ca/agentactkey/<id> | [PATCH] /caui/v1/activation-keys/manage/activation-key/ <id> | Use this API to update an existing activation key. |
| Enable/Disable Activation Key API | Not available | [PATCH] /caui/v1/activation-keys/manage/<id> | Use this API to enable/disable an activation key. |
| Change Activation Key API | [POST]/qps/rest/1.0/cak/ca/changeactkey/ | Not available | Use this API to change the activation key assigned to one or multiple Cloud Agents. |
| Delete Activation Key API | [POST] /qps/rest/1.0/delete/ca/agentactkey/<id> | [DELETE] /caui/v1/activation-keys/manage/<id> | Use this API to delete an activation key. |
The new activation key APIs can be accessed using the Qualys gateway URLs. Replace the <qualys_base_url> in the sample API requests with the correct Qualys gateway URLs. Refer to Identify your Qualys platform to check your gateway URL.