Sensor list

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

Use this endpoint to get a list with details about your sensors.

cURL
curl --location --request POST 'https://daas.digicert.com/apicontroller/v1/sensor/list' \
--header 'X-DC-DEVKEY: {{api_key}}' \
--header 'Content-Type: application/json' \
--data-raw '{"searchCriteriaList":[],"accountId":5153184,"divisionIds":[],"sortedColumnId":"name","sortOrder":"ASC"}'
200 OK
{
    "error": null,
    "data": [
        {
            "id": 59422,
            "licenseKey": "298361FD0316F91F",
            "name": "382desk_1",
            "sensorVersion": "3.8.2",
            "status": "stopped",
            "state": "inactive",
            "hostAddress": "172.18.160.70,172.17.158.97",
            "heartBeatPort": 8080,
            "commPort": 8443,
            "divisionId": 677815,
            "publishUpgradeOption": false,
            "sensorFeatures": {
                "cipherScan": true,
                "isTls13": true
            }
        },
        {
            "id": 59451,
            "licenseKey": "64CFD9CC228ACE2B",
            "name": "384Desk1",
            "sensorVersion": "3.8.4",
            "status": "error",
            "state": "inactive",
            "hostAddress": "172.18.160.70,172.17.122.161",
            "heartBeatPort": 8080,
            "commPort": 8443,
            "divisionId": 677815,
            "publishUpgradeOption": false,
            "sensorFeatures": {
                "cipherScan": true,
                "isTls13": true
            }
        },
        {
            "id": 59465,
            "licenseKey": "1B0EE18DE461033C",
            "name": "adddivdisable",
            "sensorVersion": "3.8.4",
            "status": "stopped",
            "state": "inactive",
            "hostAddress": "172.18.160.70,172.17.184.1",
            "heartBeatPort": 8080,
            "commPort": 8443,
            "divisionId": 677815,
            "publishUpgradeOption": false,
            "sensorFeatures": {
                "cipherScan": true,
                "isTls13": true
            }
        }
    ]
}

Request parameters

Name Reqd/Opt Type Description
searchCriteriaList optional array Filter results by specified values.
For definitions, see the Filter options for searchCriteriaList table below.
Example: searchCriteriaList:[{"key":"state","operation":"EQUALS","value":["ACTIVE"]}]
accountId required string Account ID.
divisionIds required array User's division ID.
sortedColumnId string Sort results by specified parameter.
Allowed values: serialNumber, ip, port, scanName, serverSecurity, isCertPresent, cn
Default: isCertPresent
sortOrder optional string Sort direction.
Allowed values: ASC (ascending: 0-9, A-Z), DESC (descending: 9-0, Z-A)
Default: ASC

Request parameters

Name Type Description
error object Includes error codes, if any.
data object Object with details about the sensors that meet the search criteria.
.. id integer Sensor ID.
.. licenseKey string License key for the sensor that is used to create a scan.
.. name string Friendly name for the sensor.
.. sensorVersion string Sensor version.
.. status string Status of the scan.
Allowed values:suspended, not_configured, install_pending, error, stopped, updating, update_pending, pending, scanning, configured.
.. state string State of the sensor.
Allowed values: inactive, enabled
.. hostAddress string Comma-separated list of host addresses associated with the sensor.
.. heartBeatPort integer At this port, sensor will start the proxy server for agents. .
.. commPort integer SSL port for data communication from agent to sensor.
.. divisionId integer Division ID.
.. publishUpgradeOption boolean If true sensor upgrade is available.
.. sensorFeatures object Details about the sensor features that are enabled.
.. .. cipherScan boolean Whether scanning for ciphers that are configured on the server is enabled.
Default: false
.. .. isTls13 boolean Whether scanning of TLS v1.3 protocol is enabled.
Default: false

Filter options for searchCriteriaList

Key Operation Value
name EQUALS Sensor name
state EQUALS Enable, Inactive
status EQUALS suspended, not_configured, install_pending, error, stopped, updating, update_pending, pending, scanning, configured.