The Reports 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. includes operations for both the legacy and the new widget-based reporting systems. To distinguish the respective Reports endpoints, two separate versions have been established:
-
Version 1 Reports endpoints: Legacy (Logi-based) reporting engine. These endpoints are deprecated and will be removed in November 2027. They remain functional for backwards compatibility only.
Important: Do not use version 1 endpoints for new development.
-
Version 2 Reports endpoints: New, widget-based reporting system. Use these endpoints to define, update, and delete reports composed of predefined widgets and report parameters. Additional endpoints let you retrieve lists of available widgets and query parsers.
Note: When selecting widgets for a report, you can customize the parameter A parameter or argument is a value that is passed into a function in an application. names and descriptions used by the widgets to better fit your users’ needs (see Customize Report Parameters).
Table 695: Reports Operations
| Endpoint | Version | Method | Description | Link |
|---|---|---|---|---|
| /{id} | 2 | GET | Generates a report using the provided report ID and parameter values. | GET Reports ID |
| /Definitions | 2 | GET | Retrieves all report definitions in a paged response. | GET Reports Definitions (v2) |
| /Definitions | 2 | POST | Creates a new report definition. | POST Report Definitions (v2) |
| /Definitions/{id} | 2 | DELETE | Deletes a report definition with the provided ID. | DELETE Report Definitions ID (v2) |
| /Definitions/{id} | 2 | GET | Retrieves the report definition with the provided ID. | GET Report Definitions GET ID (v2) |
| /Definitions/{id} | 2 | PUT | Updates a report definition. | PUT Report Definitions ID (v2) |
| /Definitions/QueryParsers | 2 | GET | Lists the query parsers available, including supported comparison operators. | GET Reports Query Parsers (v2) |
| /Widgets | 2 | GET | Lists the report widgets available. | GET Reports Widgets (v2) |
| / | 1 | GET |
Returns all built-in legacy reports with filtering and output options. This deprecated operation may be removed in a future release. It is unavailable if legacy reports are not installed. |
GET Reports |
| / | 1 | PUT |
Updates the built-in legacy report with the specified ID. Only some fields can be updated. This deprecated operation may be removed in a future release. It is unavailable if legacy reports are not installed. |
PUT Reports |
| /{id} | 1 | GET |
Returns the built-in legacy report with the specified ID. This deprecated operation may be removed in a future release. It is unavailable if legacy reports are not installed. |
GET Reports ID |
| /{id}/Parameters | 1 | GET |
Returns the parameters for the built-in legacy report with the specified report ID. This deprecated operation may be removed in a future release. It is unavailable if legacy reports are not installed. |
GET Reports ID Parameters |
| /{id}/Parameters | 1 | PUT |
Updates the parameters for the built-in legacy report with the specified report ID. This deprecated operation may be removed in a future release. It is unavailable if legacy reports are not installed. |
PUT Reports ID Parameters |
| /{id}/Schedules | 1 | GET |
Returns the schedule for the built-in legacy report with the specified report ID. This deprecated operation may be removed in a future release. It is unavailable if legacy reports are not installed. |
GET Reports ID Schedules |
| /{id}/Schedules | 1 | POST |
Creates a schedule for the built-in legacy report with the specified report ID. This deprecated operation may be removed in a future release. It is unavailable if legacy reports are not installed. |
POST Reports ID Schedules |
| /{id}/Schedules | 1 | PUT |
Updates a schedule for the built-in legacy report with the specified report ID. This deprecated operation may be removed in a future release. It is unavailable if legacy reports are not installed. |
PUT Reports ID Schedules |
| /Custom | 1 | GET |
Returns all custom reports with filtering and output options. This deprecated operation may be removed in a future release. It is unavailable if legacy reports are not installed. |
GET Reports Custom |
| /Custom | 1 | POST |
Creates a custom report. This deprecated operation may be removed in a future release. It is unavailable if legacy reports are not installed. |
POST Reports Custom |
| /Custom | 1 | PUT |
Updates the custom report with the specified ID. This deprecated operation may be removed in a future release. It is unavailable if legacy reports are not installed. |
PUT Reports Custom |
| /Custom/{id} | 1 | DELETE |
Deletes the custom report with the specified ID. This deprecated operation may be removed in a future release. It is unavailable if legacy reports are not installed. |
DELETE Reports Custom ID |
| /Custom/{id} | 1 | GET |
Returns the custom report with the specified ID. This deprecated operation may be removed in a future release. It is unavailable if legacy reports are not installed. |
GET Reports Custom ID |
| /Schedules/{id} | 1 | DELETE |
Deletes the schedule for the built-in legacy report with the specified schedule ID. This deprecated operation may be removed in a future release. It is unavailable if legacy reports are not installed. |
DELETE Reports Schedules ID |
| /Schedules/{id} | 1 | GET |
Returns the schedule for the built-in legacy report with the specified schedule ID. This deprecated operation may be removed in a future release. It is unavailable if legacy reports are not installed. |
GET Reports Schedules ID |
Was this page helpful? Provide Feedback