Documentation Suite v26.2.1

Submit Search

GET Orchestrator Jobs Job History

The GET /OrchestratorJobs/JobHistory operation retrieves the status of an in progress or completed orchestrator Keyfactor orchestrators perform a variety of functions, including managing certificate stores and SSH key stores. (a.k.a. agent) job for a given job ID. 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 requested orchestrator jobs.

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

/agents/management/read/

Table 602: GET Orchestrator Jobs Job History 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. 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, refer to: Searching Job History. The query fields supported for this operation are: AgentID Orchestrator ID matches or doesn’t match the entered GUID. This is primarily used for internally generated searches when the user is redirected here from another page. To retrieve agent IDs, run GET Agents. Agent Complete or partial matches with the orchestrator name as listed in the orchestrator field. JobID Job ID matches or doesn’t match the entered GUID. This is primarily used for internally generated searches when the user is redirected here from another page. JobType Job Type matches or does not match the referenced type. Supported categories are: Management Inventory Discovery SslDiscovery Reenrollment Monitoring Sync SSHSync Message Partial matches with the error or warning message listed in the Message field. OperationEnd Operation End before or after a specified date and time. Supports the %TODAY% token (see Advanced Search). OrchestratorPoolId Complete matches with the Keyfactor Command reference GUID for the orchestrator pool. OrchestratorPoolName Complete or partial matches with the orchestrator pool name. OperationStart Operation Start before or after a specified date and time. Supports the %TODAY% token (see Advanced Search). Result Result matches or doesn’t match the selected category: 4: Failure 3: Warning 2: Success 0: Unknown ScheduleType Schedule Type matches or does not match the referenced type. Supported schedule types are: null: Immediate I_: Interval D_: Daily W_: Weekly M_: Monthly O_: Once Status Status matches or doesn’t match the selected category: 4: Acknowledged 3: Completed 2: InProcess 1: Waiting 0: Unknown 5: CompletedWillRetry. TargetPath Complete or partial matches with the contents of the Target field, including the target machine name and the certificate store path and file name for types of jobs listing those, or for SSL jobs, the endpoint group name, or for remote CA synchronization jobs, the CA name.
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: JobId JobType Message OperationEnd OperationStart Result Status Available sort fields are affected by the query provided in QueryString. The default sort field is JobHistoryId.
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 603: GET Orchestrator Jobs Job History Response Data

Name Description

JobHistoryId An integer indicating the Keyfactor Command reference ID used to track progress during orchestrator jobs.

AgentMachine A string indicating the name of the server on which the agent or orchestrator is installed. This is not necessarily the actual DNS name of the server; the orchestrator may have been installed using an alternative as a reference name.

JobId A string indicating the Keyfactor Command reference GUID assigned to the job.

Schedule

The inventory schedule for the most recently run instance of the orchestrator job. Show schedule details.

Name

Description

Immediate

A Boolean that indicates a job scheduled to run immediately (True or False).

Tip: In some instances, jobs initially scheduled as Immediate will appear on a GET as null.

Interval

A dictionary that indicates a job scheduled to run every x minutes with the specified parameter. Any interval that is selected in the Management Portal will be converted to minutes when stored in the database.

Name	Description
Minutes	An integer indicating the number of minutes between each interval.

For example, every hour:

Copy

"Interval": {
   "Minutes": 60
}

Daily

A dictionary that indicates a job scheduled to run every day at the same time with the parameter:

Name	Description
Time	The date and time to next run the job. The date and time are expressed in ISO 8601 UTC format (YYYY-MM-DDTHH:mm:ss[.fff]Z). For example, 2026-05-19T16:23:01Z.

For example, daily at 11:30 pm:

Copy

"Daily": {
   "Time": "2023-11-25T23:30:00Z"
}

Weekly

A dictionary that indicates a job scheduled to run on a specific day or days every week at the same time with the parameters:

Name	Description
Time	The date and time to next run the job. The date and time are expressed in ISO 8601 UTC format (YYYY-MM-DDTHH:mm:ss[.fff]Z). For example, 2026-05-19T16:23:01Z.
Days	An array of values representing the days of the week on which to run the job. These can either be entered as integers (0 for Sunday, 1 for Monday, etc.) or as days of the week (for example, "Sunday").

For example, every Monday, Wednesday and Friday at 5:30 pm:

Copy

"Weekly": {
   "Days": [
      "Monday",
      "Wednesday",
      "Friday"
   ],
   "Time": "2023-11-27T17:30:00Z"
}

Monthly

A dictionary that indicates a job scheduled to run on a specific day or days every month at the same time with the parameters:

Name	Description
Time	The date and time to next run the job. The date and time are expressed in ISO 8601 UTC format (YYYY-MM-DDTHH:mm:ss[.fff]Z). For example, 2026-05-19T16:23:01Z.
Day	The number of the day, in the month, to run the job.

For example, on the first of every month at 5:30 pm:

Copy

"Monthly": {
   "Day": 1
   "Time": "2023-11-27T17:30:00Z"
}

Exactly Once

A dictionary that indicates a job scheduled to run at the time specified with the parameter:

Name	Description
Time	The date and time to next run the job. The date and time are expressed in ISO 8601 UTC format (YYYY-MM-DDTHH:mm:ss[.fff]Z). For example, 2026-05-19T16:23:01Z.

For example, exactly once at 11:45 am:

Copy

"ExactlyOnce": {
   "Time": "2023-11-27T11:45:00Z"
}

Tip: In some instances, jobs initially scheduled as Immediate will appear on a GET as ExactlyOnce.

JobType A string indicating the job type (for example, IISInventory).

OperationStart The time, in UTC, at which the orchestrator job started.

OperationEnd The time, in UTC, at which the orchestrator job finished.

Message A string providing the error message for the operation, if any.

Result

A string indicating the result of the orchestrator job. Possible values are:

Unknown
Success
Warning
Failure

Status

A string indicating the status of the orchestrator job. Possible values are:

Unknown
Waiting
In Process
Completed
Acknowledged
Completed Will Retry

StorePath A string indicating the path to the certificate store on the target. The format for this 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). See Add or Modify a Certificate Store for more information.

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.

Tip: See the Keyfactor API

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

Version v26.2.1

On This Page