The POST /Certificates/Revoke operation revokes one or more certificates with the specified IDs. On success, the operation returns HTTP 200 OK with a list of the successfully revoked certificate IDs on a success or a list of the failed certificate IDs if any revocations fail.
Permissions for certificates can be set at the system-wide or resource-specific level. The appropriate level depends on how the certificates are accessed. See Certificate Collection
The certificate search function allows you to query the Keyfactor Command database for certificates from any available source based on any criteria of the certificates and save the results as a collection that will be available in other places in the Management Portal (for example expiration alerts and certain reports). Permissions
In permission strings, # represents a specific resource identifier. In /certificates/collections/ permission strings it refers to a certificate collection ID (for example, CollectionId) and in /certificate_stores/ permission strings it refers to a certificate store application ID (for example, containerId).
Certificate enrollment refers to the process by which a user requests a digital certificate. The user must submit the request to a certificate authority (CA). (PFX A PFX file (personal information exchange format), also known as a PKCS #12 archive, is a single, password-protected certificate archive that contains both the public and matching private key and, optionally, the certificate chain. It is a common format for Windows servers., ODKG and CSR A CSR or certificate signing request is a block of encoded text that is submitted to a CA when enrolling for a certificate. When you generate a CSR within Keyfactor Command, the matching private key for it is stored in Keyfactor Command in encrypted format and will be married with the certificate once returned from the CA.), renewal, and revocation requests flow through Keyfactor Command workflow 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. (see Workflow Definitions).Table 321: POST Certificates Revoke Input Parameters
| Name | In | Description |
|---|---|---|
| CertificateIDs | Body | Required. An array of integers containing the list of Keyfactor Command reference IDs for certificates that should be revoked. |
| Reason | Body |
An integer containing the specific reason that the certificate is being revoked. The default is Unspecified. |
| Comment | Body | Required. A string containing a free-form reason or comment on why the certificate is being revoked. |
| EffectiveDate | Body | A string containing the date and time when the certificate will be revoked. 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. The default is the current date and time. Keyfactor Command only supports past and present dates for revocation. |
| CollectionId | Body |
An optional integer that specifies the certificate collection (CollectionId) to validate whether the user has sufficient permissions to perform the action. If a CollectionId is not provided, the user must have appropriate permissions granted system-wide or via certificate store applications. Providing a CollectionId allows the system to check the user's permissions at the certificate collection level. Permissions are evaluated in the following order:
Use either ContainerId or CollectionId, not both. See Certificate Collection Permissions for more information. |
| ContainerId | Body |
An optional integer that specifies the certificate store application (ContainerId) to validate whether the user has sufficient permissions to perform the action. If a ContainerId is not provided, the user must have appropriate permissions granted system-wide or via certificate collections. Providing a ContainerId allows the system to check the user's permissions at the application level. Permissions are evaluated in the following order:
Use either ContainerId or CollectionId, not both. See Application Permissions for more information. |
| PublishCRL | Body | A Boolean indicating whether a new CRL should be published following revocation (True or False). The default is True. |
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 workflow development, and also serves as an interactive supplement to this API documentation. You can access it from the help menu (
) in the Management Portal.Was this page helpful? Provide Feedback