The GET /Analytics/Certificates/Count/Collections method returns the number of active certificates for a given list of collections. This method returns HTTP 200 OK on a success with the certificate count and details.
The certificate search function allows you to query the Keyfactor Command database for certificates from any available source based on any criteria of the certificates and save the results as a collection that will be availble in other places in the Management Portal (e.g. expiration alerts and certain reports). is in beta; endpoints and parameters are subject to change in future releases of Keyfactor Command.Permissions for certificates can be configured at multiple levels. You can apply them system-wide—for all certificates—or use fine-grained control by assigning permissions at the certificate collection level. The appropriate level depends on how the certificates are accessed. See Certificate Collection Permissions for more information about system-wide versus more targeted permission models.
Table 228: GET Analytics Certificates Count Collections Input Parameters
| Name | In | Description |
|---|---|---|
| collectionIds | Query |
Optional. An integer that represents the ID of the collection to query to generate the certificate count. Multiple IDs may be specified. Use 0 for All Certificates (built-in collection). If no collectionIds are passed in, an empty response is returned. Tip: In the Keyfactor API Reference and Utility, click the Add integer item button on the Collectionids input parameter to enter the ID for each collection you wish to query.
Use the GET Certificate Collections method to retrieve a list of all the certificate collections to determine the collection ID. |
Table 229: GET Analytics Certificates Count Collections Response Data
| Name | In | Description |
|---|---|---|
| Id | Body | An integer that represents the ID of the collection. |
| Name | Body | A string with the name of the collection. |
| Count | Body |
An integer that represents the count of certificates in the collection queried. |
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. 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 Keyfactor Command, it refers to the workflow builder, which allows you to automate event-driven tasks such as when a certificate is requested, revoked or found in a certificate store. 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 bottom of the Management Portal side menu.Was this page helpful? Provide Feedback