GET Monitoring Revocation

The GET /Monitoring/Revocation operation is used to retrieve all revocation monitoring locations. Query parameters support filtering using defined criteria, control over pagination by specifying the page number and return limit, and customization of sorting based on specified fields and order. On success, the operation returns HTTP 200 OK with  details of both OCSP and 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. revocation endpointClosed An endpoint is a URL that enables the API to gain access to resources on a server. configurations.

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

/monitoring/alerts/read/
or
/certificate_authority/read/

Table 582: GET Monitoring Revocation Input Parameters

Name In Description
QueryString Query

A string containing a query to limit the results (for example, field1 -eq value1 AND field2 -gt value2). The default is to return all records. Fields available for querying through the API for the most part match those that appear in the Keyfactor Command Management Portal search dropdowns for the same feature. For querying guidelines, refer to: Using Search in the Management Portal. The query fields supported for this operation are:

  • DashboardWarningValue (WarningHours value)
  • DisplayName (Name)
  • EndpointType (1-CRL, 2-OCSP)
  • Id
  • SendWarning (emailreminder) (true, false)
  • ShowOnDashboard (true, false)
  • Url
  • WarningDays
Tip:  To return all revocation monitoring locations of type CRL, use the following query:
EndpointType -eq 1

To return locations of type OCSP, use this query:

EndpointType -eq 2
PageReturned Query An integer that specifies how many multiples of the returnLimit to skip and offset by before returning results, to enable paging. The default is 1.
ReturnLimit Query An integer that specifies how many results to return per page. The default is 50. Very large values can result in long processing time.
SortField Query

A string containing the property by which the results should be sorted. Fields available for sorting through the API include:

  • EndpointType

  • Location

  • Name

  • UseWorkflows

  • WorkflowName

Available sort fields are affected by the query provided in QueryString. The default sort field is Name.
SortAscending Query An integer that sets the sort order on the returned results. A value of 0 sorts results in ascending order while a value of 1 sorts results in descending order. The default is ascending.

Table 583: GET Monitoring Revocation Response Data

Name

Description
Dashboard

An object indicating the configuration for display on the dashboard. ClosedShow dashboard details.
Email

An object indicating the email recipients and reminder schedule for reminder alerts. ClosedShow email reminder details.
Endpoint Type A string indicating the type of revocation monitoring endpoint: OCSP or CRL.
Id An integer indicating the Keyfactor Command reference ID of the revocation monitoring location.
Location

A string indicating the location for the revocation monitoring endpoint.

For CRL endpoints, this can be either an HTTP location or an LDAP location. Be sure to 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.

For OCSP endpoints, this is the full URL to the OCSP responder servicing this certificate authority's CRL.
Name A string indicating the name of the revocation monitoring location.
OCSP Parameters

For OCSP endpoints only, an object indicating the OCSP endpoint configuration. ClosedShow OCSP endpoint details.
Schedule

An object containing the inventory schedule set for the revocation monitoring location. ClosedShow schedule details.

Name

Description
Off Turn off a previously configured schedule.
Interval A dictionary that indicates a job scheduled to run every x minutes with the specified parameter. Any interval that is selected in the Management Portal will be converted to minutes when stored in the database.
NameDescription
MinutesAn integer indicating the number of minutes between each interval.

For example, every hour:

Copy
"Interval": {
   "Minutes": 60
}
Daily

A dictionary that indicates a job scheduled to run every day at the same time with the parameter:

Name Description
Time The date and time to next run the job. The date and time are expressed in ISO 8601 UTC format (YYYY-MM-DDTHH:mm:ss[.fff]Z). For example, 2026-05-19T16:23:01Z.

For example, daily at 11:30 pm:

Copy 
"Daily": {
   "Time": "2023-11-25T23:30:00Z"
}
Note:  Although the Keyfactor API Reference and Utility—Swagger—Example Value may show examples of various other schedules, only the schedules shown here—that are available in the Management Portal for this functionality—are valid for this operation.
Use Workflows A Boolean indicating whether the alert uses workflows to deliver the alerts (True) or the legacy alerting system (False).
Workflow Enabled A Boolean indicating whether the workflow used to deliver alerts for this revocation monitoring location is enabled (True or False).
Workflow Id A string indicating the Keyfactor Command reference GUID of the workflow used to deliver alerts for this revocation monitoring location.
Workflow Name A string indicating the name of the workflow used to deliver alerts for this revocation monitoring location.
Workflow Published Version An integer indicating the published version of the workflow used to deliver alerts for this revocation monitoring location.
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.