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 Overview) are required to use this feature:
CertificateStoreManagement: Schedule
Permissions for certificate stores can be set at either the global or certificate store container level. See Container Permissions in the Keyfactor Command Reference Guide for more information about global vs container permissions.
Table 272: POST Certificate Stores Schedule Input Parameters
StoreIds |
Body |
Required. An array of strings providing the certificate store GUIDs to schedule. |
Schedule |
Body |
Required. 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 . 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: "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. 2021-05-19T16:23:01Z). |
For example, daily at 11:30 pm: "Daily": {
"Time": "2022-02-25T23:30:00Z"
}
|
ExactlyOnce |
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. 2021-05-19T16:23:01Z). |
For example, exactly once at 11:45 am: "ExactlyOnce": {
"Time": "2022-02-27T11:45:00Z"
} Tip: In some instances, jobs initially scheduled as Immediate will appear on a GET as ExactlyOnce. |
Note: Although the 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.
|