The GET /Reports method is used to return all built-in reports with filtering and output options. Query parameters enable filtering using defined criteria, control over pagination by specifying the page number and return limit, and customization of sorting based on specified fields and order. This method returns HTTP 200 OK on a success with selected details of the reports. To view details of schedules and parameters for a report, use the GET /Reports/{id} method (see GET Reports ID).
Table 652: GET Reports Input Parameters
| Name | In | Description |
|---|---|---|
| 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: Certificate Search Page. The query fields supported for this endpoint are:
Tip: This method offers limited searchable fields. The most useful search is probably by category. For example, to return all the reports tagged with the PKI Operations category:
Categories -contains "PKIOperations" |
| 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. |
| ReturnLimit | Query | An integer that specifies how many results to return per page. The default is 50. Very large values can result in long processing time. |
| SortField | Query |
A string containing the property by which the results should be sorted. Fields available for sorting through the API include:
Available sort fields are affected by the query provided in QueryString. The default sort field is DisplayName. |
| 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 653: GET Reports Response Data
| Name | Description |
|---|---|
| Id | An integer containing the Keyfactor Command reference ID for the report. |
| Scheduled | An integer indicating the number of schedules configured for the report. |
| Display Name | A string containing the display name for the report. This appears in the Keyfactor Command Management Portal on the Report Manager page, at the top of the page for the generated report, and on the menu. Tip: Exported reports use built-in names; modifying this value will not change the name that appears at the top of the exported version of a report (e.g. a PDF). |
| Description | A string containing the description for the report. This appears in the Keyfactor Command Management Portal on the Report Manager page and at the top of the page for the generated report. |
| Report Path | A string containing the name of the report as referenced when retrieving it via Logi Analytics. |
| Version Number | A string containing the version number for the report. |
| Categories |
A string containing the report category or categories in which the report is found on the report manager page in the Keyfactor Command Management Portal. The possible values are:
|
| Short Name | A string containing the short reference name for the report. |
| In Navigator | A Boolean that indicates whether the report has been configured to display on the Keyfactor Command Management Portal menu (true) or not (false). |
| Favorite | A Boolean that indicates whether the report has been marked as a favorite (true) or not (false). |
| Remove Duplicates | A Boolean that indicates whether the report uses certificate de-duping logic in producing output (true) or not (false).
Tip: When de-duplication is enabled for a report, the report results will include only the most recently issued certificate if there is more than one certificate that matches the de-duplication criteria. De-duplication can only be enabled for reports that use certificate collections—the UsesCollection parameter. The UsesCollection parameter is not user-configurable. Certificate de-duping is configured on a certificate collection using the DuplicationField parameter (see POST Certificate Collections). This corresponds to the Keyfactor Command Management Portal Ignore renewed certificate results by option on a certificate collection. Certificate collections may be configured to be de-duplicated based on the certificate common name, distinguished name, or principal name (or not at all). Only certificates that share all the EKUs (e.g. Client Authentication and Server Authentication) as well as the same CN, DN or UPN will be eliminated as duplicates. If a certificate has more than one EKU and at least one EKU does not match an otherwise similar certificate with matching CN, DN or UPN, it will not be eliminated. |
| Uses Collection | A Boolean that indicates whether the report uses a certificate collection as input for reporting (true) or not (false). |
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 top of the Management Portal page next to the Log Out button.Was this page helpful? Provide Feedback