Qualys Cloud Agent Application 2.1

April 14, 2025

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: Generate the List of Cloud Agents Assigned via Direct Assignment API

New or Updated API	Updated
API Endpoint	/caui/1.0/config-profiles/<profile-id>/agents
Method	GET
DTD or XSD Changes	Not Applicable

With this release, we have added support to generate the list of Cloud Agents assigned using Direct Assignment API (/caui/v1/config-profiles/direct-assign/<profile_id>). This API generates the paginated list of Cloud Agents.

Input ParametersInput Parameters

The following are the input parameters for Get Config Profile API.

Parameter	Optional/ Mandatory	Data Type	Description
limit	Optional	Integer	This parameter specifies the number of Cloud Agent records to be generated. If you do not define this parameter in the API request, API generates the list of all Cloud Agents assigned using Direct Assignment API. Range: 1-200.
pageNumber	Optional	Integer	This parameter defines the number of pages to be displayed in the API response. By default, one page contains 50 configuration profiles. Range: 0,1,2,3, and so on.

Parameter

Optional/ Mandatory

Data Type

Description

limit

Optional

Integer

This parameter specifies the number of Cloud Agent records to be generated.

If you do not define this parameter in the API request, API generates the list of all Cloud Agents assigned using Direct Assignment API.
Range: 1-200.

pageNumber

Optional

Integer

This parameter defines the number of pages to be displayed in the API response.

By default, one page contains 50 configuration profiles.
Range: 0,1,2,3, and so on.

Sample: Fetch Cloud Agents Assigned Via Direct Assignment APISample: Fetch Cloud Agents Assigned Via Direct Assignment API

The following sample illustrates generating list of Cloud Agents Assigned via Direct Assignment API.

API Request


    curl --location --request GET 'https://gateway.p01.eng.sjc01.qualys.com/caui/1.0/config-profiles/1832693/agents' \
    --header 'Content-Type: application/json' \
    --header 'Authorization: Bearer [jwt token]' \

API Request Body


    --data'
    {
        "limit": 1,
        "pageNumber":0
    }

API Response


    {
      "metadata":
       {         
         "pageNumber": 0,
         "pageSize": 1,
         "totalResultCount": 1     
       },
      "content": [      
       {             
         "hostName": "win11-23h2-buil",
         "agentVersion": "6.99.0.0",
         "id": 52906903         
       }
     ]
   }

To learn more about this API, refer to Cloud Agent API User Guide.

Updated API: View Invalid and Skipped Asset IDs Used for Direct Assignment

New or Updated API	Updated
API Endpoint	/caui/v1/config-profiles/direct-assign/<profile_id>
Method	PUT
DTD or XSD Changes	Not Applicable

We have updated the Direct Assignment API (/caui/v1/config-profiles/direct-assign/<profile_id>) to display the list of invalid and skipped asset IDs. Earlier, the API response only contained the status message and you could not see the asset IDs that were invalid or skipped the assignment. Now, you can view the assets IDs to which the configuration profile can not be applied. This helps you take remediation actions for invalid or skipped assets and ensure that correct configuration profile is assigned to them.

Input ParametersInput Parameters

The following are the input parameters for Direct Assignment API.

Parameter	Optional/Mandatory	Data Type	Description
agentsToBeAdded	Optional	String	Specify the asset host ID to assign the configuration profile to the associated agents.
agentsToBeRemoved	Optional	String	Specify the asset host IDs to remove the configuration profile for associated agents.

You can not leave both the agentsToBeAdded and agentsToBeRemoved parameters empty. You should at least provide the values for one of these parameters.

Sample: View Invalid and Skipped Asset IDs Provided for Direct AssignmentSample: View Invalid and Skipped Asset IDs Provided for Direct Assignment

The following sample illustrates the use of Direct Assignment API to view the Invalid and Skipped Asset IDs.

API Request

    
      curl --location --request 
      PUT '<qualys_base_url>/caui/v1/config-profiles/direct-assign/1234567'
      --header 'Content-Type: application/json' \
      --header 'Authorization: Bearer <JWT_TOKEN>'\
      --data '

API Request Body

    
       {
         "agentsToBeAdded": [60112345,60212345, 60312345, 604212345, 60512345, 60612345],
         "agentsToBeRemoved": [60112345,60212345, 60312345, 604212345, 60512345, 60612345]
       }

API Response

    
    Direct assignment request is accepted, It will be processed in sometime. For confirmation please check activity logs.
       {
           "code":400,
           "message":"Invalid Input",
           "content":{
               "invalidIdList":{},
               "skippedIdList":[
                  60112345,
                  60212345, 
                  60312345,
                  60412345,
                  60512345,
                  60612345
               ]
           }
       }

To learn more about the Direct Assignment API, refer to Cloud Agent API User Guide.