The POST /OrchestratorJobs/Reschedule method is used to reschedule a failed orchestrator
Keyfactor orchestrators perform a variety of functions, including managing certificate stores and SSH key stores. job to retry. Jobs must have a result of Failed and a status of Completed or Acknowledged to be eligible for rescheduling. This endpoint An endpoint is a URL that enables the API to gain access to resources on a server. returns 204 with no content upon success.
Only select types of jobs are eligible for rescheduling, including:
-
Certificate Store Management
-
Reenrollment
-
JKS
A Java KeyStore (JKS) is a file containing security certificates with matching private keys. They are often used by Java-based applications for authentication and encryption., PEM A PEM format certificate file is a base64-encoded certificate. Since it's presented in ASCII, you can open it in any text editor. PEM certificates always begin and end with entries like ---- BEGIN CERTIFICATE---- and ----END CERTIFICATE----. PEM certificates can contain a single certificate or a full certifiate chain and may contain a private key. Usually, extensions of .cer and .crt are certificate files with no private key, .key is a separate private key file, and .pem is both a certificate and private key. and F5 Certificate Store Discovery -
Custom Jobs scheduled to run Weekly or Monthly
The following types of jobs cannot be rescheduled with this method:
-
Certificate Store Inventory
Change the inventory schedule on certificate stores using POST /CertificateStores/Schedule (see POST Certificate Stores Schedule). -
Custom Jobs scheduled to run Immediately or Exactly Once
A new custom job should be scheduled after the problem is resolved using POST /OrchestratorJobs/Custom (see POST Orchestrator Jobs Custom). -
Fetch Logs
A new fetch logs job should be scheduled after the problem is resolved using POST /OrchestratorJobs/Custom (see POST Orchestrator Jobs Custom). -
SSL
TLS (Transport Layer Security) and its predecessor SSL (Secure Sockets Layer) are protocols for establishing authenticated and encrypted links between networked computers. Discovery and Monitoring
Change the schedule on these using PUT /SSL/Networks (see PUT SSL Networks). -
CA
A certificate authority (CA) is an entity that issues digital certificates. Within Keyfactor Command, a CA may be a Microsoft CA or a Keyfactor gateway to a cloud-based or remote CA. Synchronization for Remote CAs Managed with the Keyfactor Universal Orchestrator The Keyfactor Universal Orchestrator, one of Keyfactor's suite of orchestrators, is used to interact with servers and devices for certificate management, run SSL discovery and management tasks, and manage synchronization of certificate authorities in remote forests. With the addition of custom extensions, it can provide certificate management capabilities on a variety of platforms and devices (e.g. Amazon Web Services (AWS) resources, Citrix\NetScaler devices, F5 devices, IIS stores, JKS keystores, PEM stores, and PKCS#12 stores) and execute tasks outside the standard list of certificate management functions. It runs on either Windows or Linux servers or Linux containers.
Change the schedule on these using PUT /CertificateAuthority (see PUT Certificate Authority).
The required permissions will vary depending on the job type being rescheduled. The permissions shown above are appropriate for a certificate store management job.
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 500: POST Orchestrator Jobs Reschedule Input Parameters
| Name | In | Description |
|---|---|---|
| JobAuditIds | Body |
Required*. An array of integers indicating the job IDs of the failed jobs that should be scheduled to retry. Use the GET /OrchestratorJobs/JobHistory method (see GET Orchestrator Jobs Job History) with a query similar to the following to retrieve a list of all orchestrator jobs potentially eligible for rescheduling: JobType -ne "Inventory" AND Result -eq "4" AND (Status -eq "4" OR Status -eq "3")
Either a list of one or more JobAuditIds or a Query is required, but not both. |
| Query | Body |
Required*. A string containing a query to identify the jobs to reschedule (e.g. field1 -eq value1 AND field2 -gt value2). Fields available for querying through the API for the most part match those that appear in the Keyfactor Command Management Portal search dropdowns for the same feature. For querying guidelines, see to Scheduled Job Search Feature. Either a list of one or more JobAuditIds or a Query is required, but not both. |
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 the context of Keyfactor Command, it refers to the workflow builder, which allows you automate event-driven tasks when a certificate is requested or revoked. 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.