Alerts Expiration

The Alerts Expiration component of 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. includes methods necessary to create, update, retrieve, and delete alerts for expired certificates.

Table 205: Alerts Expiration

Endpoint

Method

Description

Link
/Alerts/Expiration/{id} DELETE Deletes an expired certificate alert for the specified ID. DELETE Alerts Expiration ID
/Alerts/Expiration/{id} GET

Retrieves details for an expired certificate alert for the specified ID.

GET Alerts Expiration ID

/Alerts/Expiration

GET

Retrieves details for all configured expired certificate alerts.

GET Alerts Expiration

/Alerts/Expiration

POST

Creates a new expired certificate alert.

POST Alerts Expiration

/Alerts/Expiration

PUT

Updates an expired certificate for the specified ID.

PUT Alerts Expiration

/Alerts/Expiration/Schedule

GET

Retrieves details of the schedule for delivery of expired certificate alerts.

Important:  This endpoint has been deprecated as of Keyfactor Command version 25.3. It will only work with the legacy alerting system. It is retained for backwards compatibility, but new development should not use this method.
GET Alerts Expiration Schedule

/Alerts/Expiration/Schedule

PUT

Updates the schedule for delivery of expired certificate alerts.

Important:  This endpoint has been deprecated as of Keyfactor Command version 25.3. It will only work with the legacy alerting system. It is retained for backwards compatibility, but new development should not use this method.
PUT Alerts Expiration Schedule
/Alerts/Expiration/Test POST

Test an Expiration Alert.

Important:  This endpoint has been deprecated as of Keyfactor Command version 25.3. It will only work with the legacy alerting system. It is retained for backwards compatibility, but new development should not use this method.
POST Alerts Expiration Test
/Alerts/Expiration/TestAll POST

Test All Expiration Alerts.

Important:  This endpoint has been deprecated as of Keyfactor Command version 25.3. It will only work with the legacy alerting system. It is retained for backwards compatibility, but new development should not use this method.
POST Alerts Expiration Test All