Qualys Cloud Agent Application Release 2.3 API

July 02, 2025

Support for IPv6 Assets in Agent Scan Merge

We have added support for IPv6 Addresses while configuring the Agent Scan Merge option. Now, you can provide the IPv6 addresses, subnets, gateways, and DNS suffixes to specify the Cloud Agents for enabling the agent scan merge feature.

To support this enhancement, we have added the following new input parameters to the Create Configuration Profile API and Update Configuration Profile API, and updated the configuration profile APIs.

New Input Parameters

We have introduced the following new input parameters for the Create Configuration Profile API and Update Configuration Profile.

Input Parameter	Mandatory/Optional	Data Type	Description
ipv6Enabled	Mandatory	Boolean	Use this parameter to allow or prevent the IPv6 assets in the Agent Scan Merge configuration. Accepted Values: true, false Default Value: false
ipv4Enabled	Mandatory	Boolean	Use this parameter to allow or prevent the IPv4 assets in the Agent Scan Merge configuration. Accepted Values: true, false Default Value: true
ipv6Address	Optional	String	Use this parameter to specify the IPv6 address in the Agent Scan Merge Configuration. This parameter is mandatory when IPv6 is enabled for the Agent Scan Merge, i.e., `ipv6Enabled=true`.
ipv6Gateway	Optional	String	Use this parameter to specify the IPv6 gateway URL in the Agent Scan Merge Configuration.
ipv6SubnetMask	Optional	String	Use this parameter to specify the IPv6 subnet masks in the Agent Scan Merge Configuration.

Ensure that at least one of IPv4 or IPv6 is enabled for the Agent Scan Merge. Both the ipv4Enabled and ipv6Enabled parameters can not be set to false.

We have updated the following configuration profile APIs to support the IPv6 assets in the Agent Scan Merge configuration.

Get Configuration Profile API: Fetch the Configuration Profile Details

New or Updated API	Updated
API Endpoint	/caui/v1/config-profiles
Method	GET
DTD and XSD Changes	NA

The Get Configuration Profile API retrieves details for the specified configuration profile. Now, we have updated this API to show the details of IPv6 assets in the API Response.

Sample: Fetch the Configuration Profile DetailsSample: Fetch the Configuration Profile Details

The following sample illustrates retrieving configuration profile details for which the IPv6 assets are added in the Agent Scan Merge option.

API Request


    curl --location --request GET '<qualys_base_url>/caui/v1/config-profiles/1234567' \
      --header 'Authorization: Bearer <JWT Token>' \
      --data ''

API Response


    {
    "id": 1234567,
    "customerId": 1122334,
    "basicDetails": {
        "profileName": "Configuration profile with tag55",
        "defaultProfSubscription": false,
        "suspendDataCollection": false,
        "inMemorySQLite": false,
        "enableQgs": false,
        "preventAutoUpdate": false,
        "spf": {
            "spfEnabled": false
        }
    },
    "assignCloudAgent": {
        "tagSet": {
            "tagSetId": "71171a8a-6d6b-45d0-8503-9f8a7c0083d5",
            "includeMatchType": "ANY",
            "includedTags": [
                {
                    "inScope": true,
                    "tagId": 24877622,
                    "name": "mmm"
                }
            ]
        }
    },
    "scanConfiguration": {
        "vm": {
            "dataCollectionInterval": 240,
            "scanDelay": 0,
            "scanRandomize": 0,
            "scanOnStartup": false
        },
        "pc": {
            "dataCollectionInterval": 720,
            "scanDelay": 0,
            "scanRandomize": 0
        },
        "sca": {
            "dataCollectionInterval": 2160
        }
    },
    "moduleConfiguration": {
        "pm": {
            "cacheSize": 2048,
            "pmEnabled": true,
            "isCacheSizeUnlimited": false
        },
        "fim": {
            "maxEventLogSize": 1024,
            "payloadThresholdTime": 300,
            "maxDiskUsage": 300,
            "dataCollectionInterval": 360,
            "fimEnabled": false
        },
        "edr": {
            "maxEventLogSize": 10240,
            "payloadThresholdTime": 1800,
            "maxDiskUsage": 2048,
            "edrEnabled": true
        },
        "epp": {
            "eppEnabled":true,
            "thirdPartyRemovalEnabled":true,
            "thirdPartyExclusionList":"Update"
        },
        "sac": {
            "sacEnabled": false
        },
        "xdr": {
            "xdrEnabled": false
        }
    },
    "agentScanMerge": {
        "enableAgentScanMerge": false,
        "bindAll": false,
        "ports": "10001,10002,10003,10004,10005",
        "ipAddress": "0.0.0.0/0"
    "performance": {
        "isCustomized": false,
        "performanceBasedOn": "LOW",
        "customizedSettings": {
            "agentStatusInterval": 900,
            "deltaUploadInterval": 10,
            "chunkSizeForFile": 1024,
            "upgradeReattemptInterval": 64800,
            "loggingLevelForAgent": "VERBOSE",
            "priorityStatusUploadInterval": 60,
            "cpuLimit": 2,
            "cpuThrottle": 20
        },
        "securitySettings": {
            "vmScanMode": "AGENTUSER"
        }
    }
}

Create Configuration Profile API: Add IPv6 Assets for Enabling Agent Scan Merge

New or Updated API	Updated
API Endpoint	/caui/v1/config-profiles
Method	POST
DTD and XSD Changes	NA

We have updated the Create Configuration Profile API to support adding IPv6 assets in the Agent Scan Merge configuration while creating a new Configuration profile. This enhancement supports adding all types of IPv6 assets, such as IP addresses, Ranges, subnets, gateways, and DNS suffixes.

Sample: Add IPv6 Assets in Agent Scan Merge ConfigurationSample: Add IPv6 Assets in Agent Scan Merge Configuration

The following API sample illustrates adding IPv6 assets to the Agent Scan Merge configurations.

API Request


  curl --location --request POST '<qualys_base_url>/caui/v1/config-profiles' \
      --header 'Content-Type: application/json' \
      --header 'Authorization: Bearer <JWT Token>' \
      --data ''

API Request Body


  {
    
    "basicDetails": {
        "profileName": "Config Profile creation12",
        "defaultProfSubscription": true,
        "suspendDataCollection": false,
        "inMemorySQLite": false,
        "enableQgs": false,
         "qgsGroupName": "TESTING",
        "preventAutoUpdate": false,
        "spf": {
             "spfEnabled":false
        }
    },
   
    "scanConfiguration": {
        "vm": {
            "dataCollectionInterval": 1234,
            "scanDelay": 555,
            "scanRandomize": 240,
            "scanOnStartup": true,
            "enableRemoteDetections": true
        },
        "pc": {
            "dataCollectionInterval": 2333,
            "scanDelay": 111,
            "scanRandomize": 77
        },
        "sca": {
            "dataCollectionInterval": 2160
        }
    },
    "moduleConfiguration": {
        "pm": {
            "cacheSize": 1234,
            "pmEnabled": 10,
            "isCacheSizeUnlimited": false
        },
        "fim": {
            "maxEventLogSize": 110,
            "payloadThresholdTime": 1300,
            "maxDiskUsage": 2048,
            "dataCollectionInterval": 2222,
            "fimEnabled": false
        },     
        "edr": {
            "maxEventLogSize": 10240,
            "payloadThresholdTime": 1800,
            "maxDiskUsage": 2048,
            "edrEnabled": true
        },
        "epp": {
            "eppEnabled":true,
            "thirdPartyRemovalEnabled":true,
            "thirdPartyExclusionList":"Update"
        },
        "sac": {
            "sacEnabled": true
        },
        "xdr": {
            "xdrEnabled": true
        }
    },
    "performance": {
        "isCustomized": false,
        "performanceBasedOn": "HIGH",
        "customizedSettings": {
            "agentStatusInterval": 7200,
            "deltaUploadInterval": 1800,
            "chunkSizeForFile": 10240,
            "upgradeReattemptInterval": 323400,
            "loggingLevelForAgent": "WARNING",
            "priorityStatusUploadInterval": 300,
            "cpuLimit": 100,
            "cpuThrottle": 1000
        },
        "securitySettings": {
            "vmScanMode": "SAFE"
        }
    },
    "reducedActivityPeriodWindows": [
        {   "rapWindowName": "RAP Profile",
            "startTime": "04:00 AM",
            "endTime": "06:00 AM",
            "selectedDays": [
                "Sunday",
                "Monday",
                "Thursday",
                "Wednesday",
                "Tuesday",
                "Friday",
                "Saturday"
            ],
            "networkRAPModules": [
                "VM",
                "PC",
                "CSAM",
                "SWCA",
                "PM",
                "CAR"
            ],
            "activityRAPModules": [
                "VM",
                "PC",
                "CSAM",
                "SWCA",
                "PM",
                "CAR"
            ]
        }
       
    ],
    "agentScanMerge":{         
 "enableAgentScanMerge": true,
 "bindAll": false,
 "ports": "10001,10002,10003,10004,10005",
 "subnetMask": "2.2.2.2",
 "ipAddress": "1.1.1.1/1",
 "gateway": "1.1.1.1",
 "ipv6Address": "2001:db8:85a3::8a2e:7334/10",
 "ipv6Gateway": "2001:db8:85a3::8a2e:7334",
 "ipv6SubnetMask": "2001:db8:85a3::8a2e:7334",
 "ipv4Enabled": true,
 "ipv6Enabled": true
 }
}

API Response


  {
    "id": 1234567,
    "customerId": 1122334,
    "name": "Config Profile creation",
    "isDefault": 0,
    "createdDate": "2025-06-06 14:50:43.0",
    "updatedDate": "2025-06-06 14:50:44.0",
    "priority": 415,
    "createdByUsername": "qualys_ab12",
    "createdByFirstName": "Patrick",
    "createdByLastName": "Slimmer",
    "updatedByUsername": "qualys_ab123",
    "updatedByFirstName": "John",
    "updatedByLastName": "Doe"
}

Update Configuration Profile API: Add IPv6 Assets for Enabling Agent Scan Merge

New or Updated API	Updated
API Endpoint	/caui/v1/config-profiles
Method	PUT
DTD and XSD Changes	NA

We have updated the Update Configuration Profile API to support adding IPv6 assets in the Agent Scan Merge configuration while updating a Configuration profile. This enhancement supports adding all types of IPv6 assets, such as IP addresses, Ranges, subnets, gateways, and DNS suffixes.

Sample: Update Agent Scan Merge Configuration for IPv6 AssetsSample: Update Agent Scan Merge Configuration for IPv6 Assets

The following sample illustrates adding IPv6 assets to an existing configuration profile.

API Request

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

API Request Body

  
    {
    "id": 1234567,
     "basicDetails": {
        "profileName": "Update API",
        "defaultProfSubscription": false,
        "suspendDataCollection": false,
        "inMemorySQLite": false,
        "enableQgs": false,
        "qgsGroupName": "TESTING",
        "preventAutoUpdate": false,
        "spf": {
            "spfEnabled": false
         }
    },
    "scanConfiguration": {
        "vm": {
            "dataCollectionInterval": 1234,
            "scanDelay": 555,
            "scanRandomize": 240,
            "scanOnStartup": true,
            "enableRemoteDetections": true
        },
        "pc": {
            "dataCollectionInterval": 2333,
            "scanDelay": 111,
            "scanRandomize": 77
        },
        "sca": {
            "dataCollectionInterval": 2160
        }
    },
    "moduleConfiguration": {
        "pm": {
            "cacheSize": 1234,
            "pmEnabled": 10,
            "isCacheSizeUnlimited": false
        },
        "fim": {
            "maxEventLogSize": 110,
            "payloadThresholdTime": 1300,
            "maxDiskUsage": 2048,
            "dataCollectionInterval": 2222,
            "fimEnabled": false
        },
        "edr": {
            "maxEventLogSize": 10240,
            "payloadThresholdTime": 1800,
            "maxDiskUsage": 2048,
            "edrEnabled": true
        },
        "epp": {
            "eppEnabled":true,
            "thirdPartyRemovalEnabled":true,
            "thirdPartyExclusionList":"Update"
        },
        "sac": {
            "sacEnabled": true
        },
        "xdr": {
            "xdrEnabled": true
        }
    },
    "performance": {
        "isCustomized": false,
        "performanceBasedOn": "HIGH",
        "customizedSettings": {
            "agentStatusInterval": 7200,
            "deltaUploadInterval": 1800,
            "chunkSizeForFile": 10240,
            "upgradeReattemptInterval": 323400,
            "loggingLevelForAgent": "WARNING",
            "priorityStatusUploadInterval": 300,
            "cpuLimit": 100,
            "cpuThrottle": 1000
        },
        "securitySettings": {
            "vmScanMode": "SAFE"
        }
    },
    "reducedActivityPeriodWindows": [
        {
            "rapWindowName": "RAP Profile",
            "startTime": "04:00 AM",
            "endTime": "06:00 AM",
            "selectedDays": [
                "Sunday",
                "Monday",
                "Thursday",
                "Wednesday",
                "Tuesday",
                "Friday",
                "Saturday"
            ],
            "networkRAPModules": [
                "VM",
                "PC",
                "CSAM",
                "SWCA",
                "PM",
                "CAR"
            ],
            "activityRAPModules": [
                "VM",
                "PC",
                "CSAM",
                "SWCA",
                "PM",
                "CAR"
            ]
        }
    ],
   "agentScanMerge":{
   "enableAgentScanMerge": true,
   "bindAll": false,         
   "ports": "10001,10002,10003,10004,10005",
   "subnetMask": "2.2.2.2",
   "ipAddress": "1.1.1.1/1",
   "gateway": "1.1.1.1",
   "ipv6Address": "2001:db8:85a3::8a2e:7334/10",
   "ipv6Gateway": "2001:db8:85a3::8a2e:7334",
   "ipv6SubnetMask": "2001:db8:85a3::8a2e:7334",
   "ipv4Enabled": true,
   "ipv6Enabled": true
   }
}

API Response

  
    {
    "code": 200,
    "message": "Configuration Profile updated successfully with Name : Update API",
    "timestamp": 1717429960235
}