The GET /CertificateStoreContainers method is used to retrieve all certificate store containers. This method returns HTTP 200 OK on a success with container details.
Permissions for certificate stores can be set at either the global or certificate store container level. See Container Permissions for more information about global vs container permissions.
Table 343: GET Certificate Store Containers Input Parameters
| Name | In | Description |
|---|---|---|
| PerformRoleCheck | Query |
This parameter is not used. |
| RoleIdList | Query | This parameter is not used. |
| QueryString | Query |
A string containing a query to limit the results (e.g. field1 -eq value1 AND field2 -gt value2). The default is to return all records. Fields available for querying through the API for the most part match those that appear in the Keyfactor Command Management Portal search dropdowns for the same feature. For querying guidelines, refer to: Using the Containers Search Feature. The query fields supported for this endpoint are:
|
| PageReturned | Query | An integer that specifies how many multiples of the returnLimit to skip and offset by before returning results, to enable paging. The default is 1. |
| SkipCount | Query | An integer indicating the number of records that should be skipped in providing results, starting from the beginning of the records (for pagination). This field is optional and no records will be skipped if not provided. |
| ReturnLimit | Query | An integer that specifies how many results to return per page. The default is 50. |
| SortField | Query | A string containing the property by which the results should be sorted. Fields available for sorting through the API for the most part match those that appear as sortable columns in the Keyfactor Command Management Portal. The default sort field is Name. |
| SortAscending | Query | An integer that sets the sort order on the returned results. A value of 0 sorts results in ascending order while a value of 1 sorts results in descending order. The default is ascending. |
Table 344: GET Certificate Stores Containers Response Data
| Name | Description |
|---|---|
| Id | An integer indicating the ID of the container. |
| Name | A string indicating the name of the container. |
| Overwrite Schedules | A Boolean indicating whether the schedule set on the container will overwrite schedules set individually on the certificate stores (true) or not (false). |
| Schedule |
A string containing the inventory schedule set for the container. Schedules are shown in cron syntax. For an interval schedule, this will look like I_mm where mm is the number of minutes (e.g. I_30 for every 30 minutes). For daily schedules, this will look like D_hh:mm where hh:mm is the time to run the job (e.g. D_14:30 for daily at 2:30 pm). |
| Cert Store Type |
An integer indicating the ID of the certificate store type, as defined in Keyfactor Command, for this certificate store. Built-in certificates store types are: (0-Javakeystore, 2-PEMFile, 3-F5SSLProfiles,4-IISRoots, 5-NetScaler, 6-IISPersonal, 7-F5WebServer, 8-IISRevoked, 9-F5WebServerREST, 10-F5SSLProfilesREST, 11-F5CABundlesREST, 100-AmazonWebServices, 101-FileTransferProtocol). Any custom extensions for the Keyfactor Universal Orchestrator you add will have certificate store types numbered 102+. |
| StoreCount | An integer indicating the number of stores of the type referenced by CertStoreType in the container. |
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. endpoints can be called and results returned. It is intended to be used primarily for validation, testing and workflow A workflow is a series of steps necessary to complete a process. In the context of Keyfactor Command, it refers to the workflow builder, which allows you automate event-driven tasks when a certificate is requested or revoked. development. It also serves secondarily as documentation for the API. The link to the Keyfactor API Reference and Utility is in the dropdown from the help icon (
) at the top of the Management Portal page next to the Log Out button.