The Certificates component of the Keyfactor 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. supports certificate lifecycle and management tasks, apart from enrollment 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)..
Table 263: Certificates Endpoints
| Endpoint | Method | Description | Link |
|---|---|---|---|
| / | DELETE | Deletes multiple certificates from the Keyfactor Command database, as specified by the IDs in the request body. | DELETE Certificates |
| / | GET | Returns all certificates with paging (number of pages to return and number of results per page) and verbosity option to specify detail level. | GET Certificates |
| /{id} | DELETE | Deletes a certificate from the Keyfactor Command database by its ID. | DELETE Certificates ID |
| /{id} | GET | Returns certificate details for a specified certificate. | GET Certificates ID |
| /{id}/History | GET | Returns the certificate operations history for a specified certificate. | GET Certificates ID History |
| /{id}/Owner | PUT | Change the certificate owner for a specified certificate. | PUT Certificates ID Owner |
| /{id}/Security | GET | Returns details of the security identities that have been granted permissions to the specified certificate including what the specific permissions are. | GET Certificates ID Security |
| /{id}/Validate | GET | Validates that a certificate chain can be built for the specified certificate. | GET Certificates ID Validate |
| {id}/Validation | GET | Returns a certificate’s validation rules and violations | GET Certificates ID Validation |
| /{id}/Validation | POST | Creates or updates a certificate’s validation rules and violations. | POST Certificates ID Validation |
| /{id}/Validation | PUT | Updates a violation for a given rule on a certificate. | PUT Certificates ID Validation ruleName violationName |
| /{id}/Validation/{ruleName} | DELETE | Deletes a given rule and it’s violations for a given certificate. | DELETE Certificates ID Validation ruleName |
| /{id}/Validation/{ruleName}/{violationName} | DELETE | Deletes a given violation for a given rule and certificate. | DELETE Certificates ID Validation ruleName violationName |
| /Analyze | POST | Reads a base-64 encoded PEM certificates and returns it in human-readable form. | POST Certificates Analyze |
| /CSV | GET | Returns content, in a CSV format, of certificates from Keyfactor Command that match the query criteria provided in the body. | GET Certificates CSV |
| /Download | POST | Downloads a certificate. | POST Certificates Download |
| /Exclude | DELETE | Deletes and excludes multiple certificates from the Keyfactor Command database based the list of IDs provided. | DELETE Certificates Exclude |
| /Exclude/{id} | DELETE | Deletes and excludes an existing certificate with the specified ID from the Keyfactor Command database. | DELETE Certificates Exclude ID |
| /Exclude/Query | DELETE | Deletes and excludes a group of certificates from Keyfactor Command that match the query criteria provided in the body. | DELETE Certificates Exclude Query |
| /ExcludedCertificates | DELETE | Deletes selected certificates from the excluded certificate list, thus re-including them into the database functionality. | DELETE Certificates Excluded Certificates |
| /ExcludedCertificates | GET | Returns all certificates on the excluded certificate list. | GET Certificates Excluded Certificates |
| /IdentityAudit/{id} | GET | Returns audit identity permissions for certificate. | GET Certificates Identity Audit ID |
| /IdentityAudit/{id} (*V2) | GET | Returns audit identity permissions for certificate. | GET Certificates Identity Audit ID |
| /Import | POST | Imports a certificate into Keyfactor Command. | POST Certificates Import |
| /Locations/{id} | GET | Returns details about the certificates stores in which the certificate is located. | GET Certificates Locations ID |
| /Metadata | PUT | Updates the metadata for a specified certificate. | PUT Certificates Metadata |
| /Metadata/All | PUT | Updates the metadata for an array of certificate IDs. | PUT Certificates Metadata All |
| /Metadata/Compare | GET | Compares the metadata value provided with the metadata value associated with the specified certificate. | GET Certificates Metadata Compare |
| /PrivateKey | DELETE | Deletes the stored private keys of multiple certificates within the Keyfactor Command database. | DELETE Certificates Private Key |
| /PrivateKey/{id} | DELETE | Deletes the stored private key(s) of a certificate within the Keyfactor Command database. | DELETE Certificates Private Key ID |
| /Query | DELETE | Deletes multiple certificates from the Keyfactor Command database based on search query. | DELETE Certificates Query |
| /QueryParsers | GET | Returns the details of all of the query parsers available in Keyfactor Command for certificate searches, along with any metadata field query parsers for each metadata type you defined in Keyfactor Command. This is a comprehensive and up-to-date reference for the queries on the Certificate Search Page and the Custom Query Count Tilefor the dashboard. | GET Certificates Query Parsers |
| /Recover | POST | Returns a recovered certificate as a PFX. | POST Certificates Recover |
| /Revoke | POST | Revokes a certificate. | POST Certificates Revoke |
Was this page helpful? Provide Feedback