API
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. changes for this release of Keyfactor Command.
Table 1211: API Change Log v25.4
| Endpoint | Methods | Action | Notes |
|---|---|---|---|
| /Analytics/Certificates/Count/Grouped | GET | Added | Returns the certificate count grouped by the selected group by field. |
| /Analytics/Certificates/Count/SigningAlgorithms | GET | Deleted | GET /Analytics/Certificates/Count/Grouped is now used instead. |
| /Analytics/Certificates/Count/Templates | GET | Deleted | GET /Analytics/Certificates/Count/Grouped is now used instead. |
| /Analytics/Certificates/Count/WeakKeys | GET | Deleted | Certificates With Weak Keys widget utilizes the GET Analytics/Certificates/Count operation now instead. |
| /Analytics/Certificates/Issuance | GET | Added | Returns the number of certificates issued in a given time period. Used for dashboard widgets. |
| /Analytics/Certificates/Revocation | GET | Added | Returns the number of certificates revoked in a given time period. Used for dashboard widgets. |
| /Applications | GET, POST, PUT | Added |
Operations added for managing certificate store applications. Tip: Previous versions of Keyfactor Command referred to the certificate store applications as containers.
|
| /Applications/{id} | DELETE, GET | Added |
Operations added for managing certificate store applications. Tip: Previous versions of Keyfactor Command referred to the certificate store applications as containers.
|
| /Certificates/{id}/Validate | GET | Breaking Change | Operations updated to return only Booleans RevocationServerOnline and ChainBuilt in response. |
| /CertificateStoreContainers | GET, POST, PUT | Deprecated | Operations deprecated due to rename of containers to applications. |
| /CertificateStoreContainers/{id} | DELETE, GET | Deprecated | Operations deprecated due to rename of containers to applications. |
| /CertificateStores/AssignApplication | PUT | Added |
Operation added due to rename of containers to applications. |
| /CertificateStores/AssignContainer | PUT | Deprecated | Operation deprecated due to rename of containers to applications. |
| /Enrollment/CSR | POST | Updated | If a default certificate owner is defined (either at the system-wide level or in the enrollment pattern) and no value is provided in the enrollment request, the default value is automatically applied upon submission. This behavior occurs regardless of whether the enrollment pattern Certificate Owner Role policy is set to Optional, Required, or Hidden. |
| /Enrollment/PFX v1 & v2 | POST | Updated | If a default certificate owner is defined (either at the system-wide level or in the enrollment pattern) and no value is provided in the enrollment request, the default value is automatically applied upon submission. This behavior occurs regardless of whether the enrollment pattern Certificate Owner Role policy is set to Optional, Required, or Hidden. |
| /Enrollment/PFX/Deploy | POST | Fixed | Error message improved when deployment fails because the enrollment template does not retain the private key. |
| /Reports | GET, PUT | Deprecated |
Operations deprecated as part of the legacy reports. Note: The v1 report operations are deprecated in advance of a planned removal to allow customers time to prepare.
|
| /Reports/{id} | GET | Deprecated |
Operations deprecated as part of the Logi-based reports. Note: The v1 report operations are deprecated in advance of a planned removal to allow customers time to prepare.
|
| /Reports/{id}/Parameters | GET, PUT | Deprecated |
Operations deprecated as part of the Logi-based reports. Note: The v1 report operations are deprecated in advance of a planned removal to allow customers time to prepare.
|
| /Reports/{id}/Schedules | GET, POST, PUT | Deprecated |
Operations deprecated as part of the Logi-based reports. Note: The v1 report operations are deprecated in advance of a planned removal to allow customers time to prepare.
|
| /Reports/Custom | GET, POST, PUT | Deprecated |
Operations deprecated as part of the Logi-based reports. Note: The v1 report operations are deprecated in advance of a planned removal to allow customers time to prepare.
|
| /Reports/Custom/{id} | GET, DELETE | Deprecated |
Operations deprecated as part of the Logi-based reports. Note: The v1 report operations are deprecated in advance of a planned removal to allow customers time to prepare.
|
| /Reports/Schedules/{id} | GET, DELETE | Deprecated |
Operations deprecated as part of the Logi-based reports. Note: The v1 report operations are deprecated in advance of a planned removal to allow customers time to prepare.
|
| /Security/Applications/{id}/Roles | GET, POST | Added | Operations added due to rename of containers to applications. |
| /Security/Containers/{id}/Roles | GET, POST | Deprecated | Operations deprecated due to rename of containers to applications. |
| /Security/Roles/{id}/Permissions | GET | Deprecated | Operations deprecated in favor of other operations that provide this functionality. |
| /Security/Roles/{id}/Permissions/Collections | GET, POST, PUT | Deprecated | Operations deprecated in favor of other operations that provide this functionality. |
| /Security/Roles/{id}/Permissions/Container | GET, POST, PUT | Deprecated | Operations deprecated in favor of other operations that provide this functionality. |
| /Security/Roles/{id}/Permissions/Global | GET, POST, PUT | Deprecated | Operations deprecated in favor of other operations that provide this functionality. |
| /Security/Roles/{id}/Permissions/PamProviders | GET, PUT | Deprecated | Operations deprecated in favor of other operations that provide this functionality. |
| /SMTP/Test | POST | v1 Deprecated | Operation version deprecated due to authentication changes in SMTP configuration. |
| /SMTP/Test | POST | v2 Added | Operation version added due to authentication changes in SMTP configuration. |
| /Templates/CADetails | POST | Added | Operation added to support creation of templates (certificate profiles and end entity profiles) in EJBCA. |
| /Templates/CADetails/{id} | GET, PUT | Added | Operations added to support modification of templates (certificate profiles and end entity profiles) in EJBCA and listing certificate templates as defined in a Microsoft CA or EJBCA instance. |
| /Templates/CustomExtensions | GET, POST, PUT | Added | Operations added to support creation of custom certificate extensions in an EJBCA instance from Keyfactor Command. |
| /Templates/ExtendedKeyUsages | GET | Added | Operation added to list all supported EKUs in Keyfactor Command. |
Was this page helpful? Provide Feedback