Documentation Suite v26.2.1

Submit Search

GET Reports ID

The GET /Reports/{id} operation returns the built-in report with the specified ID. On success, the operation returns HTTP 200 OK with the details of the report.

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/read/

This operation has two available versions. Version 1 has been deprecated. Version 2 should be used for all new integrations. For more information, see Endpoint Definition Versioning.

Version 2

Version 1

Version 2 of GET /Reports/{id} supports the current reporting system.

Table 696: GET Reports {id} v2 Input Parameters

Name In Description

Path

Required. A string indicating the Keyfactor Command reference GUID of the report to generate.

Use the GET Reports Definitions (v2) operation to retrieve a list of all the report definitions to determine the report ID.

ParameterValues

Query

An object containing the parameter values to enter to generate the report. If a custom name has been defined for the parameter, the custom name must be provided. Show report parameter details.

Default Name	Description
Agent Pool	A string that indicates the GUID of the SSL pool to use to run the report. Use the GET Agent Pools operation to retrieve a list of all the SSL pools to determine the GUID of the pool.
Certificate Collection	An integer that indicates the collection ID or 0 (zero) for all collections. Use the GET Certificate Collections operation to retrieve a list of all the certificate collections to determine the certificate collection ID.
End Date	A string with the date in the format yyyy-dd-mm. The end date must be less than or equal to the current date.
Expiring Certificates End Date	A string with the date in the format yyyy-dd-mm. The end date must be less than or equal to the current date.
Expiring Certificates Start Date	A string with the date in the format yyyy-dd-mm.
Include Unknown Status	A Boolean indicating whether to include records with an unknown certificate status (True or False).
Number of Periods	An integer that indicates the number of periods. Maximum value is 60 for days, 52 for weeks, and 36 for months.
Period Type	A string that indicates one of the available options of: Days Weeks Months
Start Date	A string with the date in the format yyyy-dd-mm.
Templates	An integer that indicates the template ID, or blank for all templates. Use the GET Templates operation to retrieve a list of all the templates to determine the template ID.

For example:

Copy

{
    "Certificate Collection": 2,
    "Include Unknown Status": "true",
    "Templates": "1,2",
    "End Date": "2026-03-9",
    "Period Type": "1",
    "Number of Periods": 12
}

Table 697: GET Reports {id} v2 Response Data

Name

Description

ReportInstanceId

The Keyfactor Command reference GUID of this report run instance.

ReportTitle A string containing the user-defined title of the report.

ReportDescription A string containing the user-defined description of the report.

Layout

The layout of a report definition contains a list of widgets (referencing predefined widgets) and their report parameters.

Note: The description and name of the parameters used by the widgets can be customized to meet your specific user needs. Customizing the parameter name allows you to use the same parameter type (for example, certificate collection) multiple times on the same report in different widgets and reference different values. For more information, see Customize Report Parameters.

Show report layout details.

Name Parameters

ReportParameters

An array of objects defining all the widget parameters for the report. Show report parameter details.

Name	Description
Value	The resulting value of this parameter for this report run instance. The type and contents will vary depending on the parameter.
Name	A string indicating the widget parameter name. This value reflects the effective parameter name—either the user-defined name (if configured) or the default name.
Description	A string indicating the optional, user-defined description of the widget parameter.
ParameterTypeId	A string indicating the Keyfactor Command reference GUID of the report parameter. If custom parameters are used, the ParameterTypeId is used to determine the parameter to widget links. This allows for the use of, for example, more than one certificate collection per report.

Widgets

An array of objects that indicate the widget data, a list of widgets, and their linked report parameters that make up the report result instance.

Show report definition widget details.

Name

Description

WidgetData

An object containing the widget data generated for this instance run of the report. Values in the WidgetData vary depending on the parameters included in the report.

Show widget data details.

A string indicating the Keyfactor Command reference GUID of the widget.

Title

A string indicating the name of the widget in this report. This is a system-defined, read-only value.

Description

A string indicating any description that may be associated with the widget. This is a system-defined, read-only value.

An integer indicating the starting horizontal (X) position of the widget on the report page. The first widget added to a page takes position 0 (zero). Each additional widget is positioned according to the grid space occupied by the widgets beside it. See Table 12: Available Widgets for the dimensions of each widget.

An integer indicating the starting vertical (Y) position of the widget on the report page. The first widget added to a page takes position 0 (zero). Each additional widget is positioned according to the grid space occupied by the widgets above it. See Table 12: Available Widgets for the dimensions of each widget.

Tip: For example, the first widget added would be at X:0 Y:0. If that widget is a 2 x 2, the next widget added would be at either X:3 or Y:3 depending on its size, and so forth.

Static

A Boolean indicating whether the widget is static (True or False). A widget is considered static if its X/Y position has been locked For more information, see Editing a Report Lock, Unlock, or Move Widgets.

Parameters

An array of objects defining the parameters in use for the report. Show parameter details.

Name	Description
Name	A string indicating the predefined name of the report parameter associated with this widget.
ReportParameter	A string indicating the user-defined name of the report parameter associated with this widget.
ParameterTypeId	A string indicating the Keyfactor Command reference GUID of the parameter type ID. This is used to link the widget to the parameter.
ParameterDataType	A string indicating the data type of the parameter. Possible values include: Bool DateTime Guid Int ListOfInts String

Text

A string containing the text provided in the user-defined Text Entry widget. This text only displays if the widget is a text-based widget. If any text is added to a non-text widgets it will get cleared upon saving. Show as Null if empty.

The widget data provided for each widget in a report run has the following format, though the parameters included will vary depending on the widget:

Copy

"WidgetData": {
   "EvalDate": "2026-03-09T00:00:00Z",
   "PeriodType": "Day",
   "Periods": [
      {
         "Label": "Corporate (CorpWebServer-MultiKey)",
         "Data": [
            {
              "Period": 3,
              "Count": 0,
              "Link": "CertificateCollection/Edit?&cid=2&InclRev=true&InclExp=true&query=TemplateId -eq \"1\" AND IssuedDate -ge \"2026-02-27T00:00:00Z\" AND IssuedDate -lt \"2026-02-28T00:00:00Z\""
            },
            {
              "Period": 2,
              "Count": 0,
              "Link": "CertificateCollection/Edit?&cid=2&InclRev=true&InclExp=true&query=TemplateId -eq \"1\" AND IssuedDate -ge \"2026-02-26T00:00:00Z\" AND IssuedDate -lt \"2026-02-27T00:00:00Z\""
            },
            {
              "Period": 1,
              "Count": 2,
              "Link": "CertificateCollection/Edit?&cid=2&InclRev=true&InclExp=true&query=TemplateId -eq \"1\" AND IssuedDate -ge \"2026-02-25T00:00:00Z\" AND IssuedDate -lt \"2026-02-26T00:00:00Z\""
            }
         ]
      },
      {
         "Label": "Corporate (CorpWebServer-RSA)",
         "Data": [
            {
               "Period": 3,
               "Count": 0,
               "Link": "CertificateCollection/Edit?&cid=2&InclRev=true&InclExp=true&query=TemplateId -eq \"2\" AND IssuedDate -ge \"2026-02-27T00:00:00Z\" AND IssuedDate -lt \"2026-02-28T00:00:00Z\""
            },
            {
               "Period": 2,
               "Count": 0,
               "Link": "CertificateCollection/Edit?&cid=2&InclRev=true&InclExp=true&query=TemplateId -eq \"2\" AND IssuedDate -ge \"2026-02-26T00:00:00Z\" AND IssuedDate -lt \"2026-02-27T00:00:00Z\""
            },
            {
               "Period": 1,
               "Count": 0,
               "Link": "CertificateCollection/Edit?&cid=2&InclRev=true&InclExp=true&query=TemplateId -eq \"2\" AND IssuedDate -ge \"2026-02-25T00:00:00Z\" AND IssuedDate -lt \"2026-02-26T00:00:00Z\""
            }
         ]
      }
   ]
 }

Version 1 of GET /Reports/{id} supports the legacy reporting system. This version has been deprecated. Version 2 supports the current reporting system and should be used instead.

Table 698: GET Reports {id} Input Parameters

Name	In	Description
id	Path	Required. An integer containing the Keyfactor Command reference ID for the report that should be retrieved. Use the GET Reports operation to retrieve a list of your built-in reports to determine the report ID to use.

Name

Description

Path

Required. An integer containing the Keyfactor Command reference ID for the report that should be retrieved.

Use the GET Reports operation to retrieve a list of your built-in reports to determine the report ID to use.

Table 699: GET Reports {id} Response Data

Name

Description

Id An integer containing the Keyfactor Command reference ID 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 (for example, 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:

CertificateCounts
CertificateLifecycle
CertificateLocations
PKIOperations
SecurityVulnerability
SSHKeys

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 False).

Favorite A Boolean that indicates whether the report has been marked as a favorite (True or False).

Remove Duplicates

A Boolean that indicates whether the report uses certificate de-duping logic in producing output (True or False).

Tip: When de-duplication is turned on 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 turned on 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 (for example, 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 False).

Report Parameter

An array of objects containing the parameters for the report. Show report parameter details.

Name	Description
Id	An integer indicating the Keyfactor Command reference ID of the report parameter.
Parameter Name	A string containing the short reference name for the report parameter (for example, EvalDate).
Parameter Type	A string containing the type of the parameter. Possible values include: Bool CertAuth (certificate authorities) Int Metadata OrchestratorPool RelativeDate SingleCA SingleMetadata SSHKeyType Templates TimePeriod
Display Name	A string containing the display name for the parameter (for example, Evaluation Date (UTC)).
Description	A string containing the description for the parameter.
Default Value	A string containing the default value for the parameter. Tip: Default values that are integers are also stored as strings in this parameter.
Display Order	An integer indicating the order in which the parameters should be displayed on the scheduling page in Keyfactor Command, beginning with 0.
Parameter Visibility	A string indicating whether the parameter should be displayed in the Keyfactor Command Management Portal. The default is Visible. The alternative setting is Hidden.

Schedules

An array of objects containing the configured schedules for running the report, if any. Show schedule details.

Name

Description

An integer indicating the Keyfactor Command reference ID of the report schedule.

Send Report

A Boolean indicating whether the report will be sent to the email recipients configured in EmailRecipients (True or False).

Save Report A Boolean indicating whether the report will be saved to the UNC path defined by SaveReportPath (True or False).

Save Report Path

A string containing the UNC path to which the report will be written, if configured.

Report Format

A string containing the report format selected for the scheduled report run. Supported values vary depending on the selected report and include:

PDF
Excel
CSV

Keyfactor Schedule

An object providing the schedule for the report. Show Keyfactor schedule details.

Name

Description

Off Turn off a previously configured schedule.

Daily

A dictionary that indicates a job scheduled to run every day at the same time with the parameter:

Name	Description
Time	The date and time to next run the job. The date and time are expressed in ISO 8601 UTC format (YYYY-MM-DDTHH:mm:ss[.fff]Z). For example, 2026-05-19T16:23:01Z.

For example, daily at 11:30 pm:

Copy

"Daily": {
   "Time": "2023-11-25T23:30:00Z"
}

Weekly

A dictionary that indicates a job scheduled to run on a specific day or days every week at the same time with the parameters:

Name	Description
Time	The date and time to next run the job. The date and time are expressed in ISO 8601 UTC format (YYYY-MM-DDTHH:mm:ss[.fff]Z). For example, 2026-05-19T16:23:01Z.
Days	An array of values representing the days of the week on which to run the job. These can either be entered as integers (0 for Sunday, 1 for Monday, etc.) or as days of the week (for example, "Sunday").

For example, every Monday, Wednesday and Friday at 5:30 pm:

Copy

"Weekly": {
   "Days": [
      "Monday",
      "Wednesday",
      "Friday"
   ],
   "Time": "2023-11-27T17:30:00Z"
}

Monthly

A dictionary that indicates a job scheduled to run on a specific day or days every month at the same time with the parameters:

Name	Description
Time	The date and time to next run the job. The date and time are expressed in ISO 8601 UTC format (YYYY-MM-DDTHH:mm:ss[.fff]Z). For example, 2026-05-19T16:23:01Z.
Day	The number of the day, in the month, to run the job.

For example, on the first of every month at 5:30 pm:

Copy

"Monthly": {
   "Day": 1
   "Time": "2023-11-27T17:30:00Z"
}

Email Recipients

An array of strings containing the email addresses of users configured as recipients of the scheduled report, if any.

Runtime Parameters

An object containing the parameters to be used at run time configured in the report schedule. Runtime parameters will vary depending on the report selected. Show runtime parameter details.

Name	Description
CertAuth	The certificate authority or authorities selected to report on.
EndDate	The end date selected for the reporting period to report on. This is configured as a certain number of days, weeks or months before or after the current date (for example, 0 days before today—meaning today).
EvalDate	The evaluation date selected for the reporting period to report on. This is configured as a certain number of days, weeks or months before or after the current date (for example, 30 days before today).
Metadata	The custom metadata fields selected to include in the report.
MinCert Count	The minimum number of certificates that must have been issued for the given template before the template will be included in the report.
Orchestrator Pool	The orchestrator pool selected to report on.
Period Count	The number of days, weeks or months selected to report on.
PeriodSize	The selected reporting period (day, weeks or months).
Requesters	The certificate requesters selected to include in the report.
SSHKey Type	The SSH key types selected to report on.
Start Date	The start date selected for the reporting period to report on. This is configured as a certain number of days, weeks or months before or after the current date (for example, 30 days before today).
Template Ids	The Keyfactor Command identifiers for the templates to include in the report.

Accepted Schedule Formats An array of strings containing the report formats supported for the report. Typically supported formats are PDF and Excel. Select reports support CSV format.

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.

Was this page helpful? Provide Feedback

Version v26.2.1

On This Page