POST Alerts Pending TestAll

The POST /Alerts/Pending/TestAll method is used to test all pending certificate request alerts. This method returns HTTP 200 OK on a success with details about the resulting number of alerts generated.

Tip:  Alerts are generated for all certificate requests that have not previously been alerted on, unless the system has been configured to send multiple alerts per request. By default, one alert is sent to each recipient for any given request. The number of alerts to send for a given request is configurable with the Pending Alert Max Reminders setting in Keyfactor Command application settings (see Application Settings: Console Tab in the Keyfactor Command Reference Guide). If a certificate remains in a pending state after the configured number of alerts has been sent, no further alerts will be sent.

By default, a maximum of 100 alerts will be generated during a test. The maximum value is configurable with the Pending Alert Test Result Limit setting in Keyfactor Command application settings (see Application Settings: Console Tab in the Keyfactor Command Reference Guide). If more than 100 alerts are generated, no email messages will be sent and you'll have the opportunity to view the first 100 alerts generated.

If you're using an event handler, the event handler is run and the handler actions taken (PowerShell script run, event log message) when the test is run. This is true regardless of the setting of the sendAlertsEmails flag.

Tip:  The following permissions (see Security Overview) are required to use this feature:

WorkflowManagement: Read
WorkflowManagement: Test

Table 175: POST Alerts Pending Test All Input Parameters

Name

In

Description
req Body

Required. An array containing information for the alert test. ClosedShow alert test details.

For example:

{
   "SendAlertEmails": false
}

Table 176: POST Alerts Pending Test All Response Data

Name Description
PendingAlerts

An object containing alert details resulting from the test. ClosedShow pending alert details.

AlertBuildResult An integer indicating the number of pending alerts run by the test.
Tip:  For code examples, see the Keyfactor API Endpoint Utility. To find the embedded web copy of this utility, click the help icon () at the top of the Keyfactor Command Management Portal page next to the Log Out button.