The PUT /Reports/Custom operation updates the custom report link with the specified ID. On success, the operation returns HTTP 200 OK with the details of the report linkage.
Important: The v1 report endpoints use the legacy reporting system and have been deprecated. They are retained for backward compatibility but require the legacy reports to be installed (see the Logi component in Install Keyfactor Command on a Windows Server Under IIS) . New development should use the v2 endpoints, which use the current reporting system.
Tip: The following permissions (see Security Roles and Claims) are required to use this feature:
/reports/modify/
Table 729: PUT Reports Custom Input Parameters
| Name | In | Description |
|---|---|---|
| CustomURL | Body | Required. A string containing the URL users should click from within Keyfactor Command to display the custom report (for example, https://mywebserver.keyexample.com/mycustomreport/). Tip: Custom reports are automatically opened in a new browser tab. |
| Id | Body |
Required. An integer containing the Keyfactor Command reference ID for the report link. Use the GET Reports Custom operation to retrieve a list of your custom report links to determine the report ID to use. |
| DisplayName | Body | Required. A string containing the display name for the report. This appears in the Keyfactor Command Management Portal on the Report Manager page and on the menu. |
| Description | Body | A string containing the description for the report. This appears in the Keyfactor Command Management Portal on the Report Manager page. |
| InNavigator | Body | A Boolean that indicates whether the report has been configured to display on the Keyfactor Command Management Portal menu (True or False). |
| Favorite | Body | A Boolean that indicates whether the report has been marked as a favorite (True or False). |
Table 730: PUT Reports Custom Response Data
| Name | Description |
|---|---|
| CustomURL | A string containing the URL users should click from within Keyfactor Command to display the custom report (for example, https://mywebserver.keyexample.com/mycustomreport/). Tip: Custom reports are automatically opened in a new browser tab. |
| Id |
An integer containing the Keyfactor Command reference ID for the report link. |
| DisplayName | A string containing the display name for the report. This appears in the Keyfactor Command Management Portal on the Report Manager page and on the menu. |
| Description | A string containing the description for the report. This appears in the Keyfactor Command Management Portal on the Report Manager page. |
| InNavigator | A Boolean that indicates whether the report has been configured to display on the Keyfactor Command Management Portal menu (True or False). |
| Favorite | A Boolean that indicates whether the report has been marked as a favorite (True or False). |
Tip: See 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. Reference and Utility, which allows you to call API operations and view results. It is primarily intended 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, and also serves as an interactive supplement to this API documentation. You can access it from the help menu (
) in the Management Portal.
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. Reference and Utility, which allows you to call API operations and view results. It is primarily intended 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, and also serves as an interactive supplement to this API documentation. You can access it from the help menu () in the Management Portal.Was this page helpful? Provide Feedback