POST Alerts Expiration Test

The POST /Alerts/Expiration/Test method is used to test individual certificate expiration alerts. This method returns HTTP 200 OK on a success with details about the resulting alerts generated or a response of “NoActionTaken” if no certificates match the test criteria entered.

Tip:  Alerts are generated when a certificate has expired or is approaching expiration as defined by the timeframe configured in the alert.

By default, a maximum of 100 alerts will be generated during a test. The maximum value is configurable with the Expiration 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 written, certificates renewed) when the test is run. This is true regardless of the setting of the SendAlerts flag.

Tip:  The following permissions (see Security Roles and Claims) are required to use this feature:
/monitoring/alerts/read/
/monitoring/alerts/test/
Important:  This endpointClosed An endpoint is a URL that enables the API to gain access to resources on a server. has been deprecated since it only works with the legacy alerting system. It is retained for backwards compatibility, but new development should not use this method.

Table 172: POST Alerts Expiration Test Input Parameters

Name

In

 Description
AlertId Body

n integer indicating the reference ID of expiration alert to test.

Use the GET /Alerts/Expiration method (see GET Alerts Expiration) to retrieve a list of all your expiration alerts to determine the alert Id.
EvaluationDate Body

A string indicating the simulation date for the test. The date and time should be given using the ISO 8601 UTC time format YYYY-MM-DDTHH:mm:ss.000Z (e.g. 2023-11-19T16:23:01Z).

You can use the date, along with the PreviousEvaluationDate, to simulate running the alerts a month from now instead of today, for example.
PreviousEvaluationDate Body A string indicating the date to simulate as the last test run date for the test. The date and time should be given using the ISO 8601 UTC time format YYYY-MM-DDTHH:mm:ss.000Z (e.g. 2023-11-19T16:23:01Z).
SendAlerts Body A Boolean indicating whether to send alert emails with the test (true) or not (false). The default is false.

Table 173: POST Alerts Expiration Test Response Data

Parameter Description
ExpirationAlerts

An object containing alert details resulting from the test. ClosedShow expiration alert details.
AlertBuildResult A string indicating the outcome of the test (e.g. Success).
Tip:  See the Keyfactor API Reference and Utility which provides a utility through which 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. endpoints can be called and results returned. It is intended to be used primarily 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. It also serves secondarily as documentation for the API. The link to the Keyfactor API Reference and Utility is in the dropdown from the help icon () at the top of the Management Portal page next to the Log Out button.