The POST /OrchestratorJobs/Acknowledge method is used to set an orchestrator
Keyfactor orchestrators perform a variety of functions, including managing certificate stores and SSH key stores. job to a status of acknowledged. Jobs must have a result of Failed or Warning and a status of Completed or CompletedWillRetry to be eligible for acknowledgment. Jobs that are in process or that have completed successfully cannot be set to a status of acknowledged. Setting a job to a status of acknowledged removes it from the count on the job history tab in the Keyfactor Command Management Portal (if the job falls within the count period defined by the Job Failures and Warnings Age Out (days) application setting—see Application Settings: Agents Tab). 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.
Table 506: POST Orchestrator Jobs Acknowledge Input Parameters
| Name | In | Description |
|---|---|---|
| JobAuditIds | Body |
Required*. An array of integers indicating the job IDs of the jobs that should be set to a status of acknowledged. 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 acknowledgment: (Result -eq "4" OR Result -eq "3") AND (Status -eq "3" OR Status -eq "5")
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 acknowledge (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.