Documentation Suite v25.2.1

Submit Search

POST Reports ID Schedules

The POST /Reports/{id}/Schedules method is used to create a schedule for the built-in report with the specified report ID. This method returns HTTP 200 OK on a success with the details of the report schedule.

Tip: The following permissions (see Security Roles and Claims) are required to use this feature:

/reports/modify/

Table 664: POST Reports {id} Schedules Input Parameters

Name

Description

Path

Required. An integer indicating the Keyfactor Command reference ID of the built-in report the schedule is associated with.

Use the GET /Reports method (see GET Reports) to retrieve a list of your built-in reports to determine the report ID to use.

Send Report

Body

A Boolean indicating whether the report will be sent to the email recipients configured in EmailRecipients (true) or not (false). The default is false.

Save Report Body A Boolean indicating whether the report will be saved to the UNC path defined by SaveReportPath (true) or not (false). The default is false.

Save Report Path

Body

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

Note: The path for saved reports must be provided in UNC format (\\servername\sharename\path) and must be accessible from the Keyfactor Command administration server. In addition:

Do not use a trailing “\” in the report path.
Ensure that the application pool service account has permission to write to the location where you want the outputted report to be saved.
When scheduling a report, schedule it for at least 10 minutes in advance of the current time if you wish it to run soon. If you want to run it faster than that, the Keyfactor Command Service will need to be restarted.

This field is required if SaveReport is set to true.

Report Format

Body

Required. 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

Body

Required. 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 should be given using the ISO 8601 UTC time format YYYY-MM-DDTHH:mm:ss.000Z (e.g. 2023-11-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 should be given using the ISO 8601 UTC time format YYYY-MM-DDTHH:mm:ss.000Z (e.g. 2023-11-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 (e.g. “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 should be given using the ISO 8601 UTC time format YYYY-MM-DDTHH:mm:ss.000Z (e.g. 2023-11-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"
}

For example:

Copy

"KeyfactorSchedule": {
   "Monthly": {
      "Day": 1,
      "Time": "2021-07-01T17:00:00Z"
   }
},

Or:

Copy

"KeyfactorSchedule": {
   "Weekly": {
      "Days": [
         "Monday",
         "Thursday"
      ],
      "Time": "2021-07-01T17:00:00Z"
   }
},

Email Recipients

Body

Required^*. An array of strings containing the email addresses of users configured as recipients of the scheduled report, if any. For example:

Copy

"EmailRecipients": [
   "pkiadmins@keyexample.com",
   "john.smith@keyexample.com"
]

This field is required if SendReport is set to true.

Runtime Parameters

Body

Required^*. 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 (e.g. 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 (e.g. 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 type(s) 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 (e.g. 30 days before today).
Template Ids	The Keyfactor Command identifiers for the templates to include in the report.

For example:

Copy

"RuntimeParameters": {
   "StartDate": "60-Day-Before",
   "EndDate": "7-Day-Before",
   "Metadata": "AppOwnerFirstName, AppOwnerLastName",
   "Requesters": "jsmith"
}

This field is required for reports that have runtime parameters.

Table 665: POST Reports {id} Schedules Response Data

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 not (false).

Save Report A Boolean indicating whether the report will be saved to the UNC path defined by SaveReportPath (true) or not (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 should be given using the ISO 8601 UTC time format YYYY-MM-DDTHH:mm:ss.000Z (e.g. 2023-11-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 should be given using the ISO 8601 UTC time format YYYY-MM-DDTHH:mm:ss.000Z (e.g. 2023-11-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 (e.g. “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 should be given using the ISO 8601 UTC time format YYYY-MM-DDTHH:mm:ss.000Z (e.g. 2023-11-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 (e.g. 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 (e.g. 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 type(s) 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 (e.g. 30 days before today).
Template Ids	The Keyfactor Command identifiers for the templates to include in the report.

Tip: See the Keyfactor API Reference and Utility which provides a utility through which 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. 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

Version v25.2.1

On this page: