POST Orchestrator Jobs Unschedule

The POST /OrchestratorJobs/Unschedule method is used to unschedule a scheduled orchestratorClosed Keyfactor orchestrators perform a variety of functions, including managing certificate stores and SSH key stores. job. This endpointClosed 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

Note:  The Keyfactor Mac Auto-Enroll Agent was deprecated as of Keyfactor Command version 11. Any Mac Auto-EnrollmentClosed 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:

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

/agents/management/modify/
/certificate_stores/schedule/
OR
/agents/management/modify/
/certificate_stores/schedule/#/ (where # is a reference to a specific certificate store container ID)

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 577: 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.

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