POST Alerts Pending Test

Important:  This operation has been deprecated. It will only work with the legacy alerting system. It is retained for backwards compatibility, but new development should not use it.

The POST /Alerts/Pending/Test operation tests individual pending certificate request alerts. On success, the operation returns HTTP 200 OK with  details about the resulting 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). 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). 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 Roles and Claims) are required to use this feature:

/monitoring/alerts/read/
/monitoring/alerts/test/

Table 248: POST Alerts Pending Test Input Parameters

Name

In

 Description
AlertId Body An integer indicating the Keyfactor Command reference ID for the pending alert.
SendAlerts Body A Boolean indicating whether to send alert emails with the test (True or False).

Table 249: POST Alerts Pending Test Response Data

Parameter Description
PendingAlerts

An object containing alert details resulting from the test. ClosedShow pending alert details.
AlertBuildResult A string indicating the result of pending alerts test (for example, Success).
Tip:  See the Keyfactor APIClosed An API is a set of functions to allow creation of applications. Keyfactor offers the Keyfactor API, which allows third-party software to integrate with the advanced certificate enrollment and management features of Keyfactor Command. Reference and Utility, which allows you to call API operations and view results. It is primarily intended for validation, testing, and workflowClosed A workflow is a series of steps necessary to complete a process. In Keyfactor Command, it refers to the workflow builder, which allows you to automate event-driven tasks such as when a certificate is requested, revoked or found in a certificate store. development, and also serves as an interactive supplement to this API documentation. You can access it from the help menu () in the Management Portal.