Documentation Suite v11.1

PUT Monitoring Revocation

The PUT /Monitoring/Revocation method is used to modify the revocation monitoring location. This method returns HTTP 200 OK on a success with details of the location.

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

/monitoring/alerts/modify/

Important: Any previously populated fields that are not submitted with their full existing data using this method will be cleared of their existing data. When using this method, you should first do a GET to retrieve all the values for the record you want to update, enter corrected data into the field(s) you want to update, and then submit all the fields using PUT, including the fields that contain values but which you are not changing.

Table 475: PUT Monitoring Revocation {id} Input Parameters

Name In Description

Id Path Required. An integer indicating the Keyfactor Command reference ID of the revocation monitoring location.

Name Body Required. A string indicating the name of the revocation monitoring location.

Endpoint Type Body Required. A string indicating the type of revocation monitoring endpoint: OCSP or CRL.

Location

Body

Required. 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.

Important: Because a “+” (plus sign) in a URL can represent either a space or a “+” Keyfactor Command has chosen to read “+” as a space. For CRL URLs that require a “+” (plus sign), rather than a space, replace plus signs in your CRL's URL with “%2B”. Only replace the plus signs you don't wish to be treated as a space.

For OCSP endpoints, this is the full URL to the OCSP responder servicing this certificate authority's CRL.

Body

Required^*. for CRL endpoints. An object indicating the email recipients and reminder schedule for reminder alerts. Show email reminder details.

Value	Description
Enable Reminder	A Boolean indicating whether to send email reminders for this location (true) or not (false). The default is false.
Warning Days	An integer indicating the number of days before expiration to send the warning email.
Recipients	An array of strings indicating the email addresses to which the email reminders should be sent.

Dashboard

Body

Required. An object indicating the configuration for display on the dashboard. Show dashboard details.

Value

Description

Show

Required. A Boolean indicating whether to show this revocation monitoring location on the Revocation Monitoring dashboard (true) or not (false). The default is false.

Warning Hours

Required^*. An integer indicating the number of hours prior to expiration when the location begins to appear in a warning state on the dashboard.

WarningHours is required if Show is set to true and EndpointType is CRL.

WarningHours is not supported for EndpointType OCSP.

If the Days or Weeks value is selected in the Management Portal, it will be converted to hours when stored in the database.

Schedule

Body

An object containing the inventory schedule set for the revocation monitoring location. Show 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 UI will be converted to minutes when stored in the database.

Name	Description
Minutes	An integer indicating the number of minutes between each interval.

For example, every hour:

"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 should be given using the ISO 8601 UTC time format YYYY-MM-DDTHH:mm:ss.000Z (e.g. 2023-11-19T16:23:01Z).

For example, daily at 11:30 pm:

"Daily": {
   "Time": "2023-11-25T23:30:00Z"
}

OCSP Parameters

Body

Required^*. for OCSP endpoints. For OCSP endpoints only, an object indicating the OCSP endpoint configuration. Show OCSP endpoint details.

Value	Description
Certificate Contents	A string containing the base-64 encoded contents of a certificate issued by the CA.
Certificate Authority Id	An integer indicating the Keyfactor Command reference ID of the CA in the database. Use the GET /CertificateAuthority method (see GET Certificate Authority) to retrieve a list of all the CAs to determine the ID.
Authority Name	A string indicating the distinguished name of the CA. For example: CN=CorpIssuingCA1, DC=keyexample, DC=com Use the POST /Monitoring/ResolveOCSP method (see POST Monitoring Resolve OSCP) with the CertificateAuthorityId or CertificateContents to resolve this value.
Authority Name Id	A string indicating the base 64 encoded SHA1 hash of the AuthorityName. Use the POST /Monitoring/ResolveOCSP method (see POST Monitoring Resolve OSCP) with the CertificateAuthorityId or CertificateContents to resolve this value.
Authority Key Id	A string indicating the base 64 encoded SHA1 hash of the CA certificate's public key. This value is found in the CA's certificate as the Subject Key Identifier (SKID). Use the POST /Monitoring/ResolveOCSP method (see POST Monitoring Resolve OSCP) with the CertificateAuthorityId or CertificateContents to resolve this value.
Sample Serial Number	A string indicating the serial number of the certificate used to identity the CA. Use the POST /Monitoring/ResolveOCSP method (see POST Monitoring Resolve OSCP) with the CertificateAuthorityId or CertificateContents to resolve this value.
FileName	A string indicating a file name for the certificate used to identify the CA for the OCSP endpoint if CertificateContents is used.

Table 476: PUT Monitoring Revocation {id} Response Data

Name

Description

Name

A string indicating the name of the revocation monitoring location.

Endpoint Type

A string indicating the type of revocation monitoring endpoint: OCSP or CRL.

Location

A string indicating the location for the revocation monitoring endpoint.

For OCSP endpoints, this is the full URL to the OCSP responder servicing this certificate authority's CRL.

An object indicating the email recipients and reminder schedule for reminder alerts. Show email reminder details.

Value	Description
Enable Reminder	A Boolean indicating whether to send email reminders for this location (true) or not (false).
Warning Days	An integer indicating the number of days before expiration to send the warning email.
Recipients	An array of strings indicating the email addresses to which the email reminders should be sent.

Dashboard

An object indicating the configuration for display on the dashboard. Show dashboard details.

Value

Description

Show

A Boolean indicating whether to show this revocation monitoring location on the Revocation Monitoring dashboard (true) or not (false).

Warning Hours

An integer indicating the number of hours prior to expiration when the location begins to appear in a warning state on the dashboard.

WarningHours is required if Show is set to true and EndpointType is CRL.

WarningHours is not supported for EndpointType OCSP.

If the Days or Weeks value is selected in the Management Portal, it will be converted to hours when stored in the database.

Schedule

An object containing the inventory schedule set for the revocation monitoring location. Show 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 UI will be converted to minutes when stored in the database.

Name	Description
Minutes	An integer indicating the number of minutes between each interval.

For example, every hour:

"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 should be given using the ISO 8601 UTC time format YYYY-MM-DDTHH:mm:ss.000Z (e.g. 2023-11-19T16:23:01Z).

For example, daily at 11:30 pm:

"Daily": {
   "Time": "2023-11-25T23:30:00Z"
}

OCSP Parameters

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

Value	Description
Certificate Authority Id	An integer indicating the Keyfactor Command reference ID of the CA in the database. This value will be null on a response if the endpoint was configured using the FileName option.
Authority Name	A string indicating the distinguished name of the CA. For example: CN=CorpIssuingCA1, DC=keyexample, DC=com
Authority Name Id	A string indicating the base 64 encoded SHA1 hash of the AuthorityName.
Authority Key Id	A string indicating the base 64 encoded SHA1 hash of the CA certificate's public key. This value is found in the CA's certificate as the Subject Key Identifier (SKID).
Sample Serial Number	A string indicating the serial number of the certificate used to identity the CA.
FileName	A string indicating a file name for the certificate used to identify the CA for the OCSP endpoint if CertificateContents is used. This value will be null on a response if the endpoint was configured using the CertificateAuthorityId option.

Tip: See the Keyfactor API Reference and Utility which provides a utility through which the Keyfactor API

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

A workflow is a series of steps necessary to complete a process. In the context of Keyfactor Command, it refers to the workflow builder, which allows you automate event-driven tasks when a certificate is requested or revoked. 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.

Version 11.1

On this page: