POST Monitoring Revocation CRL Test

The POST /Monitoring/Revocation/CRLClosed A Certificate Revocation List (CRL) is a list of digital certificates that have been revoked by the issuing Certificate Authority (CA) before their scheduled expiration date and should no longer be trusted./Test method is used to test whether a CRL endpointClosed An endpoint is a URL that enables the API to gain access to resources on a server. can be reached. It does not whether the CRL at the endpoint is still valid or has expired and does not test the delivery of email messages or other 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. features for the alert. This method returns HTTP 200 OK on a success with a message about whether the CRL was found at the specified location.

Tip:  The following permissions (see Security Roles and Claims) are required to use this feature:
/monitoring/alerts/read/

Table 582: POST Monitoring Revocation Test CRL Input Parameters

Name Description
Url

Required. A string indicating the location for the CRL endpoint. This can be either an HTTP location or an LDAP location.

Be sure to test and monitor the CRL locations that are in use by applications in your environment—if you're monitoring LDAP locations but applications are using an HTTP location, you're not going to receive any warning if a CRL fails to publish to the HTTP location.

Important:  CRL URLs that contain a plus sign (+) require careful handling. Because a plus sign in a URL can be interpreted as either a space or a literal plus sign, ensure that the CRL URL you configure is entered exactly as it would be used in a web browser or in PowerShell.
  • If the CRL is hosted on Microsoft IIS, enable Allow Double Escaping so that plus signs in the URL are processed correctly.

  • If the CRL is obtained from an EJBCA download link, use the URL exactly as generated, including any encoding.

Table 583: POST Monitoring Revocation CRL Test Response Data

Parameter Description
Success A Boolean indicating whether the CRL endpoint could be reached (true) or not (false).
Message A string indicating a message regarding the outcome of the test.
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 workflow 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 bottom of the Management Portal side menu.