Update advanced settings

2 minute read

POST https://daas.digicert.com/apicontroller/v1/sensor/updateAdvancedSettings

Use this endpoint to change advanced settings for a sensor after updates or modification.

Example requests and responses

cURL

curl --location --request POST 'https://daas.digicert.com/apicontroller/v1/sensor/updateAdvancedSettings' \
--header 'X-DC-DEVKEY: {{api_key}}' \
--header 'Content-Type: application/json' \
--data-raw '{
    "accountId": 5153184,
    "divisionId": 677793,
    "sensorId": "2A3C8D6874EADB1B",
    "advancedSettings": {
        "heartbeatInterval": "60",
        "commPorts": {
            "hbPort": 8080,
            "dataCommPort": 8443
        },
        "portChangeInProgress": false,
        "programLogs": {
            "startNow": true,
            "startAt": null,
            "manually": true,
            "timezone": "5:30#chennai"
        }
    }
}'

200 OK

{
    "error": null,
    "data": null
}

Request parameters

Name	Req/Opt.	Type	Description
accountId	required	string	Account ID.
divisionId	required	integer	Division ID.
sensorId	required	string	Sensor license key.
advancedSettings	required	object	Object with key/value pairs for each setting to update.
.. heartbeatInterval	required	integer	Sensor heartbeat interval (in seconds).
.. commPorts	optional	object	Object with key/value pairs for the port communication settings.
.. .. hbPort	required	integer	At this port, sensor will start the proxy server for agents.
.. .. dataCommPort	required	integer	SSL port for data communication between the agent and the sensor.
.. portChangeInProgress	required	boolean	If `true`, `hbPort` and `dataCommPort` changes are in progress.
.. programLogs	optional	array	Changes the log level of sensor.
.. .. startNow	optional	boolean	If `true`, then log level change will be initiated instantly.
.. .. startAt	optional	integer	The time at which the log level change will be initiated
.. .. timezone	optional	string	Time zone for the sensor to start the debug log. Format: GMT + your timezone offset. Example: `-8#pacifictime`