The Certificate Collections 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. is used to create, edit, list, and set permissions on certificate collections.
Table 370: Certificate Collections Endpoints
| Endpoint | Method | Description | Link |
|---|---|---|---|
| / | GET | Returns all certificate collections with details about the collection configuration. | GET Certificate Collections |
| / | POST | Creates a new certificate collection. | POST Certificate Collections |
| / | PUT | Updates an existing certificate collection. | PUT Certificate Collections |
| /{id} | GET | Returns the certificate collection with the specified ID. | GET Certificate Collections ID |
| /{id} | DELETE | Deletes the certificate collection with the specified ID. | DELETE Certificate Collection ID |
| /{name} | GET | Returns the certificate collection with the specified name. | GET Certificate Collections Name |
| /CollectionOrdering | GET | Returns an array of collection IDs from the dbo.CollectionOrder table in order the array which denotes the collections ordering via an ordering index. | GET Certificate Collection Ordering |
| /Copy | POST | Creates a new certificate collection based on an existing collection. | POST Certificate Collections Copy |
| /NavItems | GET | Returns the list of favorite certificate collections (that have been set to Show in Navigator). | GET Certificate Collection Nav Items |
| /{id}/Favorite | PUT | Updates the favorite setting for the collection specified. | PUT Certificate Collection ID Favorite |
| /CollectionList | GET | Returns information about the definitions for all collections, including the de-duplication setting. | GET Certificate Collections List |
| /CollectionOrdering | PUT | Takes in an array of collection IDs where the index denotes the collection's order, and replaces the CollectionOrder value in the dbo.CollectionOrder table for the affected collections. This endpoint is not displayed in the Keyfactor API Reference and Utility. | PUT Certificate Collection Ordering |
| /CertificateCollection/LastEstimated | GET | Return the last time that the timer service ran to process collections (the QueryItemsPopulator job), as well as its schedule. | GET Certificate Collection Last Estimated |
Was this page helpful? Provide Feedback