The POST /OrchestratorJobs/Unschedule method is used to unschedule a scheduled orchestrator
Keyfactor orchestrators perform a variety of functions, including managing certificate stores and SSH key stores. job. 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 unscheduling, including:
-
Certificate Store Discovery and Management
-
Reenrollment
-
Fetch Logs
-
Custom Jobs
Certificate enrollment refers to the process by which a user requests a digital certificate. The user must submit the request to a certificate authority (CA). tools and configurations in the product should not be used. The following types of jobs cannot be unscheduled with this method:
-
Certificate Store Inventory
Change the inventory schedule on certificate stores using POST /CertificateStores/Schedule (see POST Certificate Stores Schedule). -
SSH
The SSH (secure shell) protocol provides for secure connections between computers. It provides several options for authentication, including public key, and protects the communications with strong encryption. Synchronization
Change the schedule on these using PUT /SSH/ServerGroups (see PUT SSH Server Groups). -
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 unscheduled. 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 505: POST Orchestrator Jobs Unschedule Input Parameters
| Name | In | Description |
|---|---|---|
| JobIds | Body |
Required*. An array of strings indicating the GUIDs for the job IDs of the jobs that should be unscheduled. Use the GET /OrchestratorJobs/ScheduledJobs method (see GET Orchestrator Jobs Scheduled Jobs) with a query similar to the following to retrieve a list of all orchestrator jobs potentially eligible for unscheduling: JobType -notcontains "SslDiscovery" AND JobType -notcontains "Monitoring" AND JobType -notcontains "Sync" AND JobType -notcontains "SSHSync" AND JobType -notcontains "Inventory"
Either a list of one or more JobIds or a Query is required, but not both. |
| Query | Body |
Required*. A string containing a query to identify the jobs to unschedule (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 JobIds 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.