The GET /OrchestratorJobs/ScheduledJobs operation retrieves orchestrator
Keyfactor orchestrators perform a variety of functions, including managing certificate stores and SSH key stores. (a.k.a. agent) jobs that have active schedules. This includes jobs with ongoing schedules, such as inventory jobs that run periodically, and jobs that have been scheduled but have not yet been completed, such as management or discovery jobs. Both jobs that have not yet started and in-progress jobs are returned by this operation. Query parameters support filtering using defined criteria, control over pagination by specifying the page number and return limit, and customization of sorting based on specified fields and order. On success, the operation returns HTTP 200 OK with details of the scheduled orchestrator jobs.
Table 619: GET Orchestrator Jobs Scheduled Jobs Input Parameters
| Name | In | Description |
|---|---|---|
| QueryString | Query |
A string containing a query to limit the results (for example, field1 -eq value1 AND field2 -gt value2). The default is to return all records.
|
| PageReturned | Query | An integer that specifies how many multiples of the returnLimit to skip and offset by before returning results, to enable paging. The default is 1. |
| ReturnLimit | Query | An integer that specifies how many results to return per page. The default is 50. Very large values can result in long processing time. |
| SortField | Query |
A string containing the property by which the results should be sorted. Fields available for sorting through the API include:
Available sort fields are affected by the query provided in QueryString. The default sort field is Requested. |
| SortAscending | Query | An integer that sets the sort order on the returned results. A value of 0 sorts results in ascending order while a value of 1 sorts results in descending order. The default is ascending. |
Table 620: GET Orchestrator Jobs Scheduled Jobs Response Data
| Name | Description |
|---|---|
| Id | A string indicating the Keyfactor Command reference GUID assigned to the job. |
| ClientMachine | A string containing the client machine name. The value for this will vary depending on the certificate store type. Typically, it is the hostname of the machine on which the store is located, but this may vary. See Add or Modify a Certificate Store for more information. |
| Target | A string indicating the server name and path to the certificate store on the target (for example, appsrvr162.keyexample.com - /opt/app/store.cer). The server name included in the Target is the value from the ClientMachine. The format for the path will vary depending on the certificate store type. For example, for a Java KeyStore, this will be a file path (for example, /opt/myapp/store.jks), but for an F5 device, this will be a partition name on the device (for example, Common). Some types of jobs (for example, discovery) have no path. See Add or Modify a Certificate Store for more information. |
| Schedule |
The inventory schedule for the orchestrator job. |
| Requested | The time, in UTC, at which the orchestrator job was initiated and added to the job queue. |
| JobType | A string indicating the job type (for example, IISInventory). |
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. Reference and Utility, which allows you to call API operations and view results. It is primarily intended for validation, testing, and workflow 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, and also serves as an interactive supplement to this API documentation. You can access it from the help menu (
) in the Management Portal.Was this page helpful? Provide Feedback