Reports
The Reports component of the Keyfactor API 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 methods necessary to list, update, and schedule built-in reports as well as methods to create, update, list and delete custom reports.
Table 540: Reports Endpoints
Endpoint | Method | Description | Link |
---|---|---|---|
/{id} | GET | Returns the built-in report with the specified ID. | GET Reports ID |
/Custom/{id} | DELETE | Deletes the custom report with the specified ID. | DELETE Reports Custom ID |
/Custom/{id} | GET | Returns the custom report with the specified ID. | GET Reports Custom ID |
/Schedules/{id} | DELETE | Deletes the schedule for the built-in report with the specified schedule ID. | DELETE Reports Schedules ID |
/Schedules/{id} | GET | Returns the schedule for the built-in report with the specified schedule ID. | GET Reports Schedules ID |
/{id}/Parameters | GET | Returns the parameters for the built-in report with the specified report ID. | GET Reports ID Parameters |
/{id}/Parameters | PUT | Updates the parameters for the built-in report with the specified report ID. | PUT Reports ID Parameters |
/ | GET | Returns all built-in reports with filtering and output options. | GET Reports |
/ | PUT | Updates the built-in report with the specified ID. Only some fields can be updated. | PUT Reports |
/Custom | GET | Returns all custom reports with filtering and output options. | GET Reports Custom |
/Custom | POST | Creates a custom report. | POST Reports Custom |
/Custom | PUT | Updates the custom report with the specified ID. | PUT Reports Custom |
/{id}/Schedules | GET | Returns the schedule for the built-in report with the specified report ID. | GET Reports ID Schedules |
/{id}/Schedules | POST | Creates a schedule for the built-in report with the specified report ID. | POST Reports ID Schedules |
/{id}/Schedules | PUT | Updates a schedule for the built-in report with the specified report ID. | PUT Reports ID Schedules |