Get advanced settings

2 minute read

GET

https://daas.digicert.com/apicontroller/v1/sensor/advancedSettings?sensorId=A79683A885D9967C&divisionId=677793&accountId=5153184

Use this endpoint to get the advanced settings details available for the active sensors.

Example requests and responses

cURL

curl --location --request GET 'https://daas.digicert.com/apicontroller/v1/sensor/advancedSettings?sensorId=A79683A885D9967C&divisionId=677793&accountId=5153184' \
--header 'X-DC-DEVKEY: {{api_key}}' \
--header 'Content-Type: application/json' \
--data-raw '{"updatePreference":"1","sensorName":"10.198.148.237_499","licenseKey":{{license_key}},"accountId":"5153184","divisionId":677793}'

200 OK

{
    "error": null,
    "data": {
        "accountId": "5153184",
        "divisionIds": [
            677793
        ],
        "sensorId": "2A3C8D6874EADB1B",
        "sensorAdvancedSettings": {
            "heartbeatInterval": 120,
            "commPorts": {
                "hbPort": 8080,
                "dataCommPort": 8443,
                "empty": false
            },
            "portChangeInProgress": false,
            "programLogs": null
        }
    }
}

Request parameters

Name	Req/Opt.	Type	Description
licenseKey	required	string	License key of the sensor to get the settings for.
accountId	required	string	Account ID.
divisionId	required	integer	Division ID.
updatePreference	required	string	Sensor upgrade preference. `0` Automatic upgrade. `1` Manual upgrade. Manually upgrade the sensor from the UI.
sensorName	required	string	Name of the sensor.

Response parameters

Name	Type	Description
error	object	Includes error codes, if any.
data	object	Object with information about the filter results.
.. accountId	string	Account ID.
.. divisionIds	array	User’s division IDs.
.. sensorId	string	Sensor license key ID.
.. sensorAdvancedSettings	array	Includes the advanced sensor settings.
.. .. heartbeatInterval	integer	Sensor heartbeat interval.
.. .. commPorts	array	Includes the port communication settings.
.. .. .. hbPort	integer	At this port, sensor will start the proxy server for agents.
.. .. .. dataCommPort	integer	SSL port for data communication from agent to sensor.
.. .. portChangeInProgress	boolean	If `true`, `hbPort` and `dataCommPort` changes are in progress.
.. .. programLogs	array	Changes the log level of sensor.