Sensor list

  2 minute read  

POST https://daas.digicert.com/apicontroller/v1/sensor/list
Use this endpoint to get a list with details about your sensors.

Example requests and responses

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

NameReqd/OptTypeDescription
searchCriteriaListoptionalarrayFilter results by specified values. For definitions, see the Filter options for searchCriteriaList table below.
Example:
accountIdrequiredstringAccount ID.
divisionIdsrequiredarrayUser’s division ID.
sortedColumnIdstringSort results by specified parameter.
Allowed values: serialNumber, ip, port, scanName, serverSecurity, isCertPresent, cn
Default: isCertPresent
sortOrderoptionalstringSort direction.
Allowed values: ASC (ascending: 0-9, A-Z), DESC (descending: 9-0, Z-A)
Default: ASC

Request parameters

NameTypeDescription
errorobjectIncludes error codes, if any.
dataobjectObject with details about the sensors that meet the search criteria.
.. idintegerSensor ID.
.. licenseKeystringLicense key for the sensor that is used to create a scan.
.. namestringFriendly name for the sensor.
.. sensorVersionstringSensor version.
.. statusstringStatus of the scan.
Allowed values: suspended, not_configured,install_pending, error,stopped, updating, update_pending, pending, scanning, configured.
.. statestringState of the sensor.
Allowed values: inactive, enabled
.. hostAddressstringComma-separated list of host addresses associated with the sensor.
.. heartBeatPortintegerAt this port, sensor will start the proxy server for agents. .
.. commPortintegerSSL port for data communication from agent to sensor.
.. divisionIdintegerDivision ID.
.. publishUpgradeOptionbooleanIf true sensor upgrade is available.
.. sensorFeaturesobjectDetails about the sensor features that are enabled.
.. .. cipherScanbooleanWhether scanning for ciphers that are configured on the server is enabled.
Default: false
.. .. isTls13booleanWhether scanning of TLS v1.3 protocol is enabled.
Default: false

Filter options for searchCriteriaList

KeyOperationValue
nameEQUALSSensor name
stateEQUALSEnable, Inactive
statusEQUALSsuspended, not_configured, install_pending, error, stopped, updating, update_pending, pending, scanning, configured.