Update a Sensor Profile

Use this API to update a sensor profile in your account.

PUT/csapi/v1.3/sensorProfile/{sensorProfileId}

Input ParametersInput Parameters

Parameter

Mandatory/Optional

Data Type

Description

sensorProfileId

Mandatory

string

The ID/UUID for the sensor profile to update.

Request body

Mandatory

-

Provide parameter values as explained in the Request Body Parameters section below.

Request Body ParametersRequest Body Parameters

Parameter

Mandatory/Optional

Data Type

Description

profileName

Mandatory

string

Specify a title for your sensor profile.

description

Optional

string

Specify a description for your sensor profile.

profileType

Mandatory

 

Specify the type of sensor profile.

associatedRegistryIds

Mandatory

 

Add one or more registries to the registry sensor profile by specifying the registry IDs.

These are the registries that will be scanned by the sensors in the same profile.

associatedSensorIds

Mandatory

 

Add one or more sensors to this profile by specifying the sensor IDs.

filter

-

string

 

config

 

 

weeklyBlackoutWindowSchedules

startTime

 -

 string

Configure a window of time in which the sensors in your profile will not operate.

endTime

 -

 string

repeatOnDays

 -

 string

vulnerabilityManagement

containerScanningInterval

-

integer

Select a scanning interval for how often sensors should rescan containers.

Valid interval values are: 12, 24, and 48.

An interval of 48 hours is recommended for optimum performance.

imageExclusionRegexList

-

string

Create an image exclusion list using regular expressions.

Images matching the exclusion list are not scanned by the sensors in this profile.

globalScanningFlag

-

Boolean

 Turn on or off all the scan operations.

scanningPolicy

-

string

 Specify one of the following policies:

  • DynamicWithStaticScanningAsFallback: Performs dynamic scanning

  • Dynamic: Performs static scanning as a fallback to dynamic scanning for images without a shell.

performanceManagement

maxNoOfArchivedLogFiles

 -

integer

Specify the maximum number of log files to achieve. The remaining files will be purged.

maxLogFileSize

 -

integer

Specify the maximum file size for each log file. After the file size is achieved for a file, a new file is created.

logSecurityLevel

 -

string

 Specifies the type of log data to be logged.

SampleSample

API request

    curl -X POST
"<qualys_base_url>/csapi/v1.3/sensorProfile/6963d471-7598-4d4d-b95c-e540c75745b2" 
-H "accept: application/json"
-H "Content-Type: application/json"
-H "Authorization: Bearer <token>"
    

Request Body

    {
    "profileId": "6963d471-7598-4d4d-b95c-e540c75745b2",
    "profileName": "General-test2",
    "profileType": "General",
    "description": "",
    "createdBy": "test_zp53",
    "created": "1669108423070",
    "updatedBy": null,
    "updated": "1669111816485",
    "config": {
        "weeklyInactiveWindowSchedules": [
            {
                "repeatOnDays": [
                    "SUNDAY"
                ],
                "allDayToggle": false,
                "startTime": "01:15",
                "endTime": "03:00"
            }
        ],
        "vulnerabilityManagement": {
            "globalScanningFlag": true,
            "scanningPolicy": "DynamicWithStaticScanningAsFallback",
            "containerScanningInterval": 48,
            "imageExclusionRegexList": []
        },
        "performanceManagement": {
            "maxNoOfArchivedLogFiles": 5,
            "maxLogFileSize": 10,
            "logSecurityLevel": "INFORMATION"
        }
    },
    "associatedSensorIds": [
        "f1edef37-8d72-4f5d-87ed-9d6da981cffe"
    ],
    "associatedRegistryIds": null
}
    

Response

    {
    "profileUuid": "6963d471-7598-4d4d-b95c-e540c75745b2"
}