Cloud Agent Application Release 2.9 API

November 18, 2026

Advanced Settings for Peer-to-Peer Distribution

Peer-to-peer to distribution now provides advanced settings for more control over content distribution. With these advanced configuration parameters, you can control peer discovery interval, limit peer connections for a Cloud Agent, exclude subnets from peer discovery, and assign correct Admin and Transport ports to manage how content moves across your peer network.

To support advanced configuration parameters for peer-to-peer distribution, we have updated the following Cloud Agent APIs.

Get Configuration Profile Details

New or Updated API Updated
API Endpoint /caui/v1/config-profiles
Method GET
JSON Schema Changes No

The Get Configuration Profile API now shows the advanced peer-to-peer distribution settings details.

Sample: Get configuration profile details with advanced peer-to-peer distribution settingsSample: Get configuration profile details with advanced peer-to-peer distribution settings

The following sample illustrates using Get Configuration Profile API to fetch profile details.

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
        },
  "p2pConfigSetting": {
        "enabled": true,
        "minCacheSizeGB": 12,
        "maxCacheSizeGB": 13,
        "minRetentionDays": 3,
        "maxRetentionDays": 11,
       "transportPort": 7400,
  "adminPort": 7401,
  "discoveryInterval": 30,   "enableMaxPeerConnections": false,  "maxPeerConnections": 0, "excludeSubnets": [ "0.0.0.0/10" ]     },
        "securitySettings": {
            "vmScanMode": "AGENTUSER"
        }
    }
}

Create Configuration Profile

New or Updated API Updated
API Endpoint /caui/v1/config-profiles
Method POST
JSON Schema Changes No

We have introduced the following new input parameters for the Create Configuration Profile API to support advanced settings in peer-to-peer distribution.

New Input ParametersNew Input Parameters

We have added the following new parameters under peer-to-peer distributions for advanced settings.

Parameter Mandatory/Optional Data Type Description
discoveryInterval Optional integer Use this parameter to control how often a Cloud Agent in the peer network scans for available peers.
Valid range: 5-30 minutes.
Default value: 10 minutes.
enableMaxPeerConnections Optional Boolean Use this parameter to enable the control for maximum number of peers for a Cloud Agent.
maxPeerConnections Optional Integer Use this parameter to control the maximum number of peer connections for a Cloud Agent.
Valid range: 10-500
Default value: 200
excludeSubnets Optional String Use this parameter to specify the IPv4 and IPv6 addresses or subnets to be excluded from the peer network.

Sample: Create configuration profile with advanced peer-to-peer distribution settingsSample: Create configuration profile with advanced peer-to-peer distribution settings

The following sample illustrates using Create Configuration Profile API to create a profile with advanced peer-to-peer distribution settings.

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"
            ]
        }
       
    ],
    "p2pConfigSetting": {
        "enabled": true,
        "minCacheSizeGB": 12,
        "maxCacheSizeGB": 13,
        "minRetentionDays": 3,
        "maxRetentionDays": 11,
        "transportPort": 7400,
        "adminPort": 7401,
        "discoveryInterval": 30,
        "enableMaxPeerConnections": false,
        "maxPeerConnections": 0,
        "excludeSubnets": [ "0.0.0.0/10" ] 
    },
    "agentScanMerge": {
        "enableAgentScanMerge": true,
        "bindAll": true,
        "ports": "10001,10002,10003,10004",
        "subnetMask": "21.111.123.123",
        "ipAddress": "123.123.123.123/12",
        "gateway": "111.222.12.55",
        "dnsSuffixRegex": "String value"
    }
}
    

API Response

    {
    "id": 1234567,
    "customerId": 1122334,
    "name": "Config Profile creation",
    "isDefault": 1,
    "createdDate": "2024-06-06 14:50:43.0",
    "updatedDate": "2024-06-06 14:50:44.0",
    "priority": 783,
    "createdByUsername": "qualys_ab12",
    "createdByFirstName": "Patrick",
    "createdByLastName": "Slimmer",
    "updatedByUsername": "qualys_ab12",
    "updatedByFirstName": "Patrick",
    "updatedByLastName": "Slimmer"
}
  

Update Configuration Profile

New or Updated API Updated
API Endpoint /caui/v1/config-profiles
Method PATCH
JSON Schema Changes No

We have introduced the following new input parameters for the Update Configuration Profile API to support advanced settings in peer-to-peer distribution.

New Input ParametersNew Input Parameters

We have added the following parameters for peer-to-peer distribution advanced settings.

Parameter Mandatory Data Type Description
discoveryInterval Optional integer Use this parameter to control how often a Cloud Agent in the peer network scans for available peers.
Valid range: 5-30 minutes.
Default value: 10 minutes.
enableMaxPeerConnections Optional Boolean Use this parameter to enable the control for maximum number of peers for a Cloud Agent.
maxPeerConnections Optional Integer Use this parameter to control the maximum number of peer connections for a Cloud Agent.
Valid range: 10-500
Default value: 200
excludeSubnets Optional String Use this parameter to specify the IPv4 and IPv6 addresses or subnets to be excluded from the peer network.

Sample: Update configuration profile with advanced peer-to-peer distribution settingsSample: Update configuration profile with advanced peer-to-peer distribution settings

The following sample illustartes using Update Configuration Profile API to update a profile with advanced peer-to-peer distribution settings.

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"
            ]
        }
    ],
    "p2pConfigSetting": {
        "enabled": true,
        "minCacheSizeGB": 12,
        "maxCacheSizeGB": 13,
        "minRetentionDays": 3,
        "maxRetentionDays": 11,
        "transportPort": 7400,
        "adminPort": 7401,
        "discoveryInterval": 30,
        "enableMaxPeerConnections": false,
        "maxPeerConnections": 0,
        "excludeSubnets": [ "0.0.0.0/10" ] 
    },
    "agentScanMerge": {
        "enableAgentScanMerge": true,
        "bindAll": true,
        "ports": "10001,10002,10003,10004",
        "subnetMask": "11.111.123.123",
        "ipAddress": "111.222.123.123/2",
        "gateway": "1.11.22.33",
        "dnsSuffixRegex": "String Value"
    }
}
      

API Response

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