Skip to main content

Get sensor details

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

Use this endpoint to get information about a sensor.

Example requests and responses

Example 1. cURL
curl --location --request POST 'https://daas.digicert.com/apicontroller/v1/sensor/getSensorDetails' \
--header 'X-DC-DEVKEY: {{api_key}}'' \
--header 'Content-Type: application/json' \
--data-raw '{"licenseKey":{{license_key}},"accountId":5153184,"divisionId":677793}'

Request parameters

Name

Req/Opt

Type

Description

licenseKey

required

string

Sensor license key .

accountId

required

string

Account ID.

divisionId

required

integer

Division ID.

Response parameters

Name

Type

Description

error

object

Includes the error code, if any.

data

object

Object container for response.

.. accountId

string

Account ID.

.. divisionId

integer

Division ID.

.. licenseKey

string

Sensor license key.

.. sensorName

string

Name of the sensor.

.. updatePreference

string

Sensor upgrade preference.

0 Automatic upgrade.

1 Manual upgrade.

Manually upgrade the sensor from the CertCentral UI.

.. stateString

string

Sensors state.

Possible values: Inactive, Enabled

.. statusString

string

Sensor status.

Possible values: Suspended, Not_configured, Install_pending, Error, Stopped, Updating, Update_pending, Scanning, Configured.

.. sensorVersion

string

Sensor version.

.. updateAvailable

boolean

Indicates whether a new sensor upgrade is available.

Default: false.

.. publishUpgradeOption

boolean

If updatePreference is 1 and sensor upgrade is available, it will be true.

.. emailAddresses

string

Comma- separated list of email addresses for the contacts associated with the sensor.

In this section: