Use this endpoint to get the number of alerts displayed on the Discovery dashboard for various modules, including:
curl --location --request POST 'https://daas.digicert.com/apicontroller/v1/wall/alertCount' \
--header 'X-DC-DEVKEY: {{api_key}}' \
--header 'Content-Type: application/json' \
--data-raw ' {
"accountId": 126993,
"moduleName": "endPoint",
"divisionIds": [69748, 69750, 97665, 253787, 96846, 70530, 100045, 98332, 126324,
69749, 303027, 94317, 124925, 553810, 531373, 376492],
"daysToExpire": 30
}'{
"error": null,
"data": 1243
}| Name | Req/Opt | Type | Description |
|---|---|---|---|
| accountId | required | string | Account ID. |
| moduleName | required | string |
Name of module to get alert count for. See: Module table below.Allowed values: scan, cert, rotationElapsed, endpoint, duplicateKeys, sensor, isKeyDiscovered, sensorUpgrade, codeSigningCert,, userCert, insecureAlgorithms, insecureCiphers, unsignedBinaries, agentInError, keystoreWithoutAccess
|
| divisionIds | required | array | List of division IDs. |
| daysToExpire | conditional | integer |
Number of days until certificate expiration. Note: If moduleName is cert,endPoint, codeSigningCert,userCert your request must include either a daysToExpire or certStatus value. Use the daysToExpire parameter to request the number of alerts for certificates expiring in a certain number of days.
|
| certStatus | conditional | string |
Certificate status. Allowed values: REVOKEDNote: If moduleName is cert or endPoint, your request must include either a daysToExpire or certStatus value. Use the certStatus parameter to request the number of alerts for revoked certificates.
|
| serverHost | conditional | string |
Use this parameter only for moduleName related to ServerCert, Binaries and Keys page.
|
| Name | Type | Description |
|---|---|---|
| error | object | Includes the error code, if any. |
| data | integer |
Alert count. NOTE: When you request an alert count for the isKeyDiscovered module, the data response parameter returns a value of 0 (no alerts discovered) or 1 (alerts discovered).
|
| Module name parameter | Friendly name in the Dashboard |
|---|---|
scan, sensor, sensorUpgrade
|
Sensor and scan alerts |
cert
|
Certificate alerts |
endpoint
|
TSL/SSL server issues |
rotationElapsed, duplicateKeys, isKeyDiscovered
|
Key alerts |