Qualys Cloud Platform 3.19.1 (CA) API Notification 1

Whats New?
New API: Software Component Report Download API to Download SwCA Scan Report as per Cyclone Dx Standard in JSON Format
Added Support for New Qualys Application Mitigation

A new release of Qualys Cloud Platform 3.19.1 (CA) includes new and updated APIs which is targeted for release in November 2024. The specific day will differ depending on the platform. See platform release dates on the Qualys Status page. This API notification provides an early preview into the coming API changes, allowing you to identify use cases that can leverage this updated API.

What’s New?

In this release, we have introduced a new API to download Software Composition Analysis (SwCA) Scan Reports in JSON format, following the CycloneDX standard. Additionally, support for the Qualys Mitigation application has been added, enabling you to manage Qualys Mitigation on Cloud Agents. Updated APIs are available to activate or deactivate Mitigation on individual or multiple agents, create and update activation keys, and retrieve activation key details.

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

POST /qps/rest/1.0/download/ca/downloadcdxsbom/

In this release, we have introduced a new API that supports downloading Software Composition Analysis (SwCA) Scan Report as per CycloneDX standard in JSON format. Using the cdxschemaversion parameter, you can specify the report version CYCLONE_DX_1_4 or CYCLONE_DX_1_6 to download.

Added Support for New Qualys Application ‒ Mitigation

This release introduces support for the new Qualys Mitigation application. You can now enable Qualys Mitigation on your Cloud Agents and initiate mitigation jobs for vulnerabilities detected on your assets. This feature is designed to help reduce risks associated with vulnerabilities for which patches are unavailable or cannot be applied due to system unavailability.

To support the Qualys Mitigation application, we have updated the below listed Cloud Agent APIs. These APIs allow you to manage Mitigation features, including enabling or disabling Qualys Mitigation on individual or multiple Cloud Agents, creating and provisioning activation keys, updating existing activation keys, and retrieving activation key details.

Please note that this feature is only available for Cloud Agent versions that support Qualys Mitigation.

Activate Single Agent API: Activate Single Agent for Qualys Mitigation

POST /qps/rest/2.0/activate/am/asset/<id>?module=<value1>,<value2>

Activate Multiple Agents API: Activate Multiple Agents for Qualys Mitigation

POST /qps/rest/2.0/activate/am/asset?module=<value1>,<value2>

Deactivate Single Agent API: Deactivate Single Agent for Qualys Mitigation

POST /qps/rest/2.0/deactivate/am/asset/<id>?module=<value1>,<value2>

Deactivate Multiple Agents API: Deactivate Multiple Agents for Qualys Mitigation

POST /qps/rest/2.0/deactivate/am/asset?module=<value1>,<value2>

Create Activation Key API: Create Activation Key for Qualys Mitigation

POST /qps/rest/1.0/create/ca/agentactkey/

Update Activation Key API: Update Activation Key for Qualys Mitigation

POST /qps/rest/1.0/update/ca/agentactkey/<id>

Get Activation Key Details API: View Activation Key Detail

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

Please note that, for these APIs the DTD or XSD remains unchanged.

Please refer the release note here for more details: https://docs.qualys.com/en/portal-cloud-platform-rn/cloud_platform/release_3_19_1_api.htm