POST Enrollment Renew

The POST /EnrollmentClosed 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)./Renew operation enrolls for a certificate renewal for a certificate that exists in Keyfactor Command. On success, the operation returns HTTP 200 OK with  details of the new certificate.

For certificates in a certificates store, this operation does not automatically deploy the new certificate to the certificate store. In this case, the renew request should be followed by a call to either the POST /Enrollment/PFXClosed 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./Deploy or POST /Enrollment/PFX/Replace operation to deploy the new certificate to the certificate store.

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

One of:

/certificates/enrollment/pfx/ AND /certificates/collections/read/
OR
/certificates/enrollment/pfx/ AND /certificates/collections/read/#/
OR, if the certificate is in a certificate store
/certificates/enrollment/pfx/ AND /certificate_stores/read/ AND /certificate_stores/schedule/
OR
/certificates/enrollment/pfx/ AND /certificate_stores/read/#/ AND /certificate_stores/schedule/#/

Permissions for certificate stores can be set at the system-wide level or certificate store application level. See Application Permissions for more information.

In permission strings, # represents a specific resource identifier. In /certificate_stores/ permission strings it refers to a certificate store application ID (for example, containerId).

Note:  All enrollment (PFX, ODKG and CSRClosed 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 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. (see Workflow Definitions).

Table 498: POST Enrollment Renew Input Parameters

Name In Description
CollectionId Query

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:

  1. System-wide certificate permissions
  2. Granular certificate permissions

Use either ContainerId or CollectionId, not both.

See Certificate Collection Permissions for more information.
ContainerId Query

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:

  1. System-wide certificate store application permissions
  2. Granular certificate store application permissions

Use either ContainerId or CollectionId, not both.

See Application Permissions for more information.
CertificateAuthority Body

Required in some cases. A string that sets the name of the certificate authority that will be used to enroll against. The certificate authority name should be provided in hostname\\logical name format. For example:

corpca01.keyexample.com\\CorpIssuingCA1

This field is required if one-click renewal is not supported for the certificate (see GET Enrollment Available Renewal ID or GET Enrollment Available Renewal Thumbprint).
CertificateId Body

Required in some cases. The integer for the certificate in Keyfactor Command that needs to be renewed.

Either the CertificateId or the Thumbprint is required but not both.
Enrollment Pattern Id Body

Required in some cases. An integer indicating the enrollment pattern to use when renewing the certificate. If this value is not provided, the default enrollment pattern defined for the template provided in the request (see the Template parameter) will be used.

One of Template or EnrollmentPatternId is required except when:

If both the Template and EnrollmentPatternId are provided, the settings from the enrollment pattern take precedence. If both are specified, the enrollment will fail if the Template does not match the one defined by the specified enrollment pattern.
Template Body

Required in some cases. A string that sets the name of the certificate template that should be used to issue the certificate. The template short name should be used. See also EnrollmentPatternId.

One of Template or EnrollmentPatternId is required except when:

If both the Template and EnrollmentPatternId are provided, the settings from the enrollment pattern take precedence. If both are specified, the enrollment will fail if the Template does not match the one defined by the specified enrollment pattern.

Important:  The template must be configured with at least one enrollment pattern to be used for enrollment (see POST Enrollment Patterns).
Note:  This parameter is considered deprecated and may be removed in a future release.
Thumbprint Body

Required in some cases. The thumbprint for the certificate that needs to be renewed.

Either the CertificateId or the is required but not both.
Timestamp Body

Required. The current date and time. 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.

Table 499: POST Enrollment Renew Response Data

Name Description
DispositionMessage Enrollment message. For example: The private key was successfully retained.
IssuerDN Issuer DN of the certificate.
KeyfactorID ID of the certificate in Keyfactor Command.
KeyfactorRequestID ID of the request in Keyfactor Command.
Password A password generated for convenience for use on installation to a certificate store. This password may be used when deploying the certificate to a certificate store using the POST /Enrollment/Deploy operation, though an alternate password may be used. The passwords do not need to match.
RequestDisposition State of the request (for example, issued).
SerialNumber Serial number of the certificate.
Thumbprint Thumbprint of the certificate.
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 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.