Software Component Download API

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

Using this API you can view or download the Software Composition Analysis (SwCA) Scan Report in JSON format as per the CycloneDx standard.

The API response has an option to download the SwCA Scan Report in JSON format. Once downloaded, API response displays a success message with proper status code.

Permissions Required: CA Manager users should have all the permissions. Other users must have Access Permissions - API Access and Asset Management Permissions - Read Asset.

Input ParametersInput Parameters

Use the following input parameters to generate the SwCA Scan Report.

Input Parameter	Mandatory/Optional	Data Type	Description
assetId	Mandatory	Integer	Specify the unique assetID for which you want to download the SwCA Scan Report.
cdxschemaversion	Mandatory	String	Specify the CyclonDx Schema Version for your reports. Acceptable values: CYCLONE_DX_1_4, CYCLONE_DX_1_6

Sample: Download the SwCA Scan ReportSample: Download the SwCA Scan Report

The following API illustrates downloading SwCA scan report in JSON format as per the CycloneDX_1_6. standard.

API Response


    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

    
    200 OK