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 1203: API Change Log v26.2.1
| Endpoint | Methods | Action | Notes |
|---|---|---|---|
| /Agents | GET | Updated | OrchestratorPool parameter added to response. |
| /Agents/{id} | GET | Updated | OrchestratorPool parameter added to response. |
| /Agents/Approve | POST | Added | V2 operation adds support for orchestrator pools. |
| /Alerts/Denied/TokenParsers | GET | Added | Operation to retrieve available token parsers. |
| /Alerts/Expiration/TokenParsers | GET | Added | Operation to retrieve available token parsers. |
| /Alerts/Issued/TokenParsers | GET | Added | Operation to retrieve available token parsers. |
| /Alerts/Pending/TokenParsers | GET | Added | Operation to retrieve available token parsers. |
| /Analytics/Certificates/Count/Collections | GET | Updated | This Analytics operations now return an object at the top level called Results. |
| /Analytics/Certificates/Count/Grouped | GET | Updated | This Analytics operations now return an object at the top level called Results. |
| /Analytics/RevocationMonitoring/Status | GET | Added | Operation to support dashboard widget for Revocation Monitoring. |
| /Analytics/SSL/Networks/Endpoints | GET | Updated | This Analytics operations now return an object at the top level called Results. |
| /Analytics/SSL/Networks/Endpoints/Status | GET | Updated | This Analytics operations now return an object at the top level that is called Results and returns the counts of each status grouped by the network they are associated with. |
| /Certifcates/Recover | POST | Updated | RootCertificateId parameter added to the request. |
| /CertificateCollections | GET | Updated | New query parser, ExcludeUserSpecificCollections, that if True, excludes user-specific conditionals from the collection results. User-specific conditionals include %ME%, %ME-AN%, and %ROLES%. The default is False. |
| /Certificates/{id}/Roots | GET | Added | Operation related to trust bundles. |
| /Certificates/Download | POST | Updated | RootCertificateId parameter added to the request. |
| /Certificates/Revoke | POST | Updated | Keyfactor Command only supports past and present dates for revocation Effective Date. |
| /CertificateStores | POST, PUT | Added | V2 operation adds support for orchestrator pools. |
| /CertificateStores/Aliases | GET | Added | This operation accepts a list of certificate store id GUIDs as a query parameter and returns the aliases contained in the certificate store. |
| /CertificateStores/Certificates/Add | POST | Updated | Added the RootCACertificateIds parameter to specify one or more root certificate authorities (CAs) when installing a certificate in a certificate store, supporting multiple valid trust chains. |
| /CertificateStores/DiscoveryJob | POST | Added | V2 operation adds support for orchestrator pools. |
| /CertificateStores/Reenrollment | POST | Updated | Added the Schedule parameter to support ExactlyOnce delivery in addition to the previous standard of Immidiate. |
| /CertificateStoreTypes | POST, PUT | Fixed | Required custom fields now require a default value. |
| /Enrollment/CSR/Context/My | GET | Fixed | Now correctly return metadata values configured on the referenced enrollment patterns and templates. |
| /Enrollment/CSR/Context/My | GET | Updated | Operation now returns both template and enrollment pattern data. |
| /Enrollment/PFX/Context/My | GET | Fixed | Now correctly return metadata values configured on the referenced enrollment patterns and templates. |
| /Enrollment/PFX/Context/My | GET | Updated | Operation now returns both template and enrollment pattern data. |
| /EnrollmentPatterns | GET, POST, PUT | Updated | Includes a new enum property CSRSANControl within the Policies section that replaces the Allow CSR SAN Entry enrollment application setting, which has been removed. |
| /EnrollmentPatterns/{id} | GET | Updated | Includes a new enum property CSRSANControl within the Policies section that replaces the Allow CSR SAN Entry enrollment application setting, which has been removed. |
| /EnrollmentPatterns/Settings | PUT, GET | Updated | Includes a new enum property CSRSANControl within the Policies section that replaces the Allow CSR SAN Entry enrollment application setting, which has been removed. |
| /EventHandlerRegistration | GET | Updated | New query parser AlertType with supported comparison operator -eq and comparison values Denied, Expiration, Issued, and Pending. |
| /JobTypes/Pooled | GET | Added | New operation to support orchestrator pools. |
| /MetadataFields/Names | GET | Added | New operation to list the metadata fields defined in Keyfactor Command. |
| /Monitoring/Revocation | GET | Updated | Id added as query parser for input. |
| /OrchestratorJobs/Custom | POST | Added | V2 operation adds support for orchestrator pools. |
| /OrchestratorJobs/Custom | POST | Updated | V1 operation adds the OrchestratorPoolId parameter to response. |
| /OrchestratorJobs/Custom/Bulk | POST | Added | V2 operation adds support for orchestrator pools. |
| /OrchestratorJobs/Reschedule | POST | Fixed | Operation now returns 400 with friendly error message rather than 204 when no results are found with the provided query. |
| /OrchestratorJobs/Reschedule | POST | Updated | Response code if the provided Query returns no values has been changed from 204 to 400. |
| /OrchestratorPools | GET, POST | Added | New operations to support orchestrator pools. |
| /OrchestratorPools/{id} | GET, PUT, DELETE | Added | New operations to support orchestrator pools. |
| /OrchestratorPools/{id}/Orchestrators | GET, PUT, DELETE | Added | New operations to support orchestrator pools. |
| /Reports/{id} | GET | Added | V2 Report operation for the new reporting engine. Runs a report. |
| /Reports/Definitions | GET, POST | Added | V2 Report operation for the new reporting engine definitions. |
| /Reports/Definitions/{id} | GET, PUT, DELETE | Added | V2 Report operation for the new reporting engine definitions. |
| /Reports/Definitions/QueryParsers | GET | Added | V2 Report operation for the new reporting engine query parsers. |
| /Reports/Widgets | GET | Added | V2 Report operation for the new reporting engine widget list and details. |
| /Security/Roles/{id}/Claims | PUT, DELETE | Added | Operation to add new security claims into Keyfactor Command and assign it to a security role and remove claims from a role. |
| /SMTP/TestOnly | POST | Added | V2 Operation to support testing the SMTP settings by sending a test email message for users with only the test permission. |
| /Status/ApplicationInfo | GET | Added | Operation to return the Keyfactor Command database version in major.minor.patch.build format. |
| /Templates |
GET, PUT |
Updated |
|
| /Templates/{id} | GET | Updated |
|
| /TrustBundles | GET, POST | Added | Operations for managing trust bundles. |
| /TrustBundles/{id} | PUT, DELETE | Added | Operations for managing trust bundles. |
| /TrustBundles/{id}/Certificates | GET, POST, DELETE | Added | Operations for managing certificates in a trust bundle. |
| /TrustBundles/{id}/Download | POST | Added | Operation to download all certificates in a trust bundle. |
| /TrustBundles/Certificates/QueryParsers | GET | Added | Operation to list query parsers available for trust bundle certificates. |
| /TrustBundles/QueryParsers | GET | Added | Operation to list query parsers available for trust bundles. |
| /Users/My | GET | Added | Operation to retrieve the username associated with the authenticated Keyfactor Command session. |
Was this page helpful? Provide Feedback