POST Certificate Stores Schedule
The POST /CertificateStores/Schedule method is used to create and assign a schedule to one or more certificate stores in Keyfactor Command. The POST request must contain an array of certificate store GUIDs and the properties that make up the schedule to attach to the store(s). This returns 204 with no content upon success.
Tip: The following permissions (see
Security Roles and Claims) are required to use this feature:
/certificate_stores/schedule/
OR
/certificate_stores/schedule/#/ (where # is a reference to a specific certificate store container ID)
Permissions for certificate stores can be set at either the global or certificate store container level. See Container Permissions for more information about global vs container permissions.
Table 397: POST Certificate Stores Schedule Input Parameters
StoreIds |
Body |
Required. An array of strings providing the certificate store GUIDs to schedule. |
Schedule |
Body |
Required. An object indicating the inventory schedule for the certificate store(s). Show schedule details.
Off |
Turn off a previously configured schedule. |
Immediate |
A Boolean that indicates a job scheduled to run immediately (true) or not (false).
Tip: In some instances, jobs initially scheduled as Immediate will appear on a GET as null.
|
Interval |
A dictionary that indicates a job scheduled to run every x minutes with the specified parameter. Any interval that is selected in the UI will be converted to minutes when stored in the database.Minutes | An integer indicating the number of minutes between each interval. |
For example, every hour: Copy"Interval": { "Minutes": 60 }
|
Daily |
A dictionary that indicates a job scheduled to run every day at the same time with the parameter:
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" }
|
Exactly Once |
A dictionary that indicates a job scheduled to run at the time specified with the parameter:
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, exactly once at 11:45 am: Copy"ExactlyOnce": { "Time": "2023-11-27T11:45:00Z" }
Tip: In some instances, jobs initially scheduled as Immediate will appear on a GET as ExactlyOnce. |
Note: Although the Keyfactor API Reference and Utility—Swagger—Example Value may show examples of various other schedules, only the schedules shown here—that are available in the Management Portal for this functionality—are valid for this endpoint.
|
Tip: See the
Keyfactor API Reference and Utility which provides a utility through which the
Keyfactor endpoints can be called and results returned. It is intended to be used primarily for validation, testing and 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.