Release 3.3.2.1 API

December 16, 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?

New API - List Software Components for All Assets

New or Updated API	New
API Endpoint	/rest/2.0/asset/component/
Method	POST
DTD or XSD changes	Not Applicable

With this release, we have introduced a new API to fetch the list of all components discovered from the SwCA Scan. If the component to software mapping is enabled, user can view the component to parent software application relation based on the scan results.

Input ParametersInput Parameters

Parameter	Sub Parameter	Mandatory/Optional	Data Type	Description
pageNo	NA	Mandatory	Number	Provide the input for the pageSize. The default value is 0.
pageSize	NA	Mandatory	Number	Provide the input for the page size between 0 to 1000. The default value is 1000.
componentFilter	component.name	Optional	String	Provide the name of the component.
	component.version	Optional	String	Provide the version of the component.
	component.technology	Optional	String	Provide the technology used by the component.
assetSoftwareFilter		Optional	String	Provide the lifecycle stage of the software component. All "software" and "asset" prefixed QQL tokens are supported.

Sample - List of Software Components for All AssetsSample - List of Software Components for All Assets

API Request - without filter

curl --location --request POST 
'<qualys_base_url>/rest/2.0/asset/component?pageNo=0&pageSize=1000' 
--header 'Authorization: Bearer <JWT Token>'
--header 'Content-Type: application/json'

API Request - with filter

curl --location --request POST 
'<qualys_base_url>/rest/2.0/asset/component?pageNo=0&pageSize=1000
&componentFilter=component.name:`log4j`&assetSoftwareFilter=asset.riskScore > 100
 and operatingSystem:"Windows" and software:(lifecycle.stage:`EOL/EOS`)' 
--header 'Authorization: Bearer <JWT Token>' 
--header 'Content-Type: application/json'

API Response

{
  "assetComponentsList": [
    {
      "assetId": 40338595,
      "assetUUID": "a231ec1f-4ee3-4b4d-a222-9be8b3970b52",
      "component": {
        "name": "apache-common-utils",
        "version": "1.1",
        "technology": ".NET",
        "installPath": "/usr/bin/apache-http/1.1/lib",
        "firstFoundAt": 1733129365228,
        "lastFoundAt": 1733129366228,
        "parentSoftwareList": [
          {
            "id": 5707384187482443000,
            "fullName": "Apache HTTP Server 1.1",
            "version": "1.1"
          },
          {
            "id": 5707384187482443001,
            "fullName": "Apache HTTP Server 1.2",
            "version": "1.2"
          }
        ],
        "parentComponentList": [
          {
            "id": 5707384187482444111,
            "name": "apache-common",
            "version": "1.1",
            "installPath": "/usr/bin/apache-http/1.1/lib"
          },
          {
            "id": 5707384187482443001,
            "name": "apache-poi",
            "version": "1.2",
            "installPath": "/usr/bin/apache-http/1.1/lib"
          }
        ]
      }
    },
    {
      "assetId": 40338595,
      "assetUUID": "a231ec1f-4ee3-4b4d-a222-9be8b3970b52",
      "component": {
        "name": "apache-common-utils",
        "version": "1.1",
        "technology": ".NET",
        "installPath": "/usr/bin/apache-tomcat/1.1/lib",
        "firstFoundAt": 1733129365228,
        "lastFoundAt": 1733129366228,
        "componentParentSoftwareList": [
          {
            "id": 5707384187482443000,
            "fullName": "Apache HTTP Tomcat 10.5",
            "version": "10.5"
          }
        ],
        "parentComponentList": []
      }
    },
    {
      "assetId": 40338595,
      "assetUUID": "a231ec1f-4ee3-4b4d-a222-9be8b3970b52",
      "component": {
        "name": "apache-common-utils",
        "version": "2.2",
        "technology": ".NET",
        "installPath": "/usr/bin/apache-http/2.2/lib",
        "firstFoundAt": 1733129365228,
        "lastFoundAt": 1733129366228,
        "componentParentSoftwareList": [
          {
            "id": 5707384187482443000,
            "fullName": "Apache HTTP Server 2.1",
            "version": "2.1"
          },
          {
            "id": 5707384187482443001,
            "fullName": "Apache HTTP Server 2.1",
            "version": "2.2"
          }
        ],
        "parentComponentList": [
          {
            "id": 5707384187482444111,
            "name": "apache-common",
            "version": "2.1",
            "installPath": "/usr/bin/apache-http/2.1/lib"
          },
          {
            "id": 5707384187482443001,
            "name": "apache-poi",
            "version": "2.2",
            "installPath": "/usr/bin/apache-http/2.1/lib"
          }
        ]
      }
    },
    {
      "assetId": 51449686,
      "assetUUID": "2860dc69-3e79-4828-856f-66593a28628a",
      "component": {
        "name": "apache-common-utils",
        "version": "2.2",
        "technology": ".NET",
        "installPath": "/opt/apache/bin/apache-http/2.2/lib",
        "firstFoundAt": 1733129367228,
        "lastFoundAt": 1733129367228,
        "componentParentSoftwareList": [
          {
            "id": 5707384187482443000,
            "fullName": "Apache HTTP Server 2.1",
            "version": "2.1"
          },
          {
            "id": 5707384187482443001,
            "fullName": "Apache HTTP Server 2.1",
            "version": "2.2"
          }
        ],
        "parentComponentList": [
          {
            "id": 5707384187482444111,
            "name": "apache-common",
            "version": "2.1",
            "installPath": "/opt/apache/bin/apache-http/2.1/lib"
          },
          {
            "id": 5707384187482443001,
            "name": "apache-poi",
            "version": "2.2",
            "installPath": "/opt/apache/bin/apache-http/2.1/lib"
          }
        ]
      }
    }
  ]
}

New API - List Software Components for Specific Asset ID

New or Updated API	New
API Endpoint	/rest/2.0/asset/component/{assetUuid}
Method	POST
DTD or XSD changes	Not Applicable

With this release, we have introduced a new API that fetches the list of software components for a specific assetUuid discovered from the SwCA scan. If the component to software mapping is enabled, user can view the component to parent software application relation based on the scan results.

Input ParametersInput Parameters

Parameter	Sub Parameter	Mandatory/Optional	Data Type	Description
pageNo	NA	Mandatory	Number	Provide the input for the pageSize. The default value is 0.
pageSize	NA	Mandatory	Number	Provide the input for the page size between 0 to 1000. The default value is 1000.
componentFilter	component.name	Optional	String	Provide the name of the component.
	component.version	Optional	String	Provide the version of the component.
	component.technology	Optional	String	Provide the technology used by the component.
assetsoftwareFilter		Optional	String	Provide the input as per the asset or software token provided in the query. All "asset" and "software" prefixed QQL tokens are supported.

Sample - List of Software Components for Specific AssetIDSample - List of Software Components for Specific AssetID

API Request - without filter

curl --location --request POST '<qualys_base_url>/rest/2.0/asset/component/{assetUuid}?pageNo=0&pageSize=1000' 
--header 'Authorization: Bearer <JWT Token>' 
--header 'Content-Type: application/json'

API Request - with filter

curl --location --request POST 
'<qualys_base_url>/rest/2.0/asset/component/2860dc69-3e79-4828-856f-66593a28628a?pageNo=0&pageSize=1000
&componentFilter=component.name:`log4j`&softwareFilter=software:(lifecycle.stage:`EOL/EOS` or authorization:`Unauthorized`)' 
--header 'Authorization: Bearer <JWT Token>' 
--header 'Content-Type: application/json'

API Response

{
  "assetId": 51449686,
  "assetUUID": "2860dc69-3e79-4828-856f-66593a28628a",
  "componentsList": [
    {
      "name": "apache-common-utils",
      "version": "2.2",
      "technology": ".NET",
      "installPath": "/opt/apache/bin/apache-http/2.2/lib",
      "firstFoundAt": 1733129367228,
      "lastFoundAt": 1733129367228,
      "componentParentSoftwareList": [
        {
          "id": 5707384187482443000,
          "fullName": "Apache HTTP Server 2.1",
          "version": "2.1"
        },
        {
          "id": 5707384187482443001,
          "fullName": "Apache HTTP Server 2.1",
          "version": "2.2"
        }
      ],
      "parentComponentList": [
        {
          "id": 5707384187482444111,
          "name": "apache-common",
          "version": "2.1",
          "installPath": "/opt/apache/bin/apache-http/2.1/lib"
        },
        {
          "id": 5707384187482443001,
          "name": "apache-poi",
          "version": "2.2",
          "installPath": "/opt/apache/bin/apache-poi/2.1/lib"
        }
      ]
    },
    {
      "name": "apache-common-utils",
      "version": "2.3",
      "technology": ".NET",
      "installPath": "/opt/apache/bin/apache-http/2.3/lib",
      "firstFoundAt": 1733129367228,
      "lastFoundAt": 1733129367228,
      "componentParentSoftwareList": [
        {
          "id": 5707384187482443000,
          "fullName": "Apache HTTP Server 2.3",
          "version": "2.3"
        },
        {
          "id": 5707384187482443001,
          "fullName": "Apache HTTP Server 2.4",
          "version": "2.3"
        }
      ],
      "parentComponentList": [
        {
          "id": 5707384187482444111,
          "name": "apache-common",
          "version": "2.3",
          "installPath": "/opt/apache/bin/apache-common/2.3/lib"
        },
        {
          "id": 5707384187482443001,
          "name": "apache-poi",
          "version": "2.4",
          "installPath": "/opt/apache/bin/apache-poi/2.4/lib"
        }
      ]
    }
  ]
}