GET Orchestrator Jobs Job Status Data

The GET /OrchestratorJobs/JobStatus/Data operation returns the data generated from a completed custom orchestratorClosed 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. On success, the operation returns HTTP 200 OK with  up to 2 MB of data from the job results.

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

/agents/management/read/

Tip:  This operation can return the log results from a Fetch Logs job initiated for the Keyfactor Universal OrchestratorClosed 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 (for example 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.. The last 2 MB of data from the orchestrator's log file are returned as a string in the Data field.
Tip:  If jobs for the Keyfactor Universal Orchestrator fail with messages similar to the following:

2021-08-05 10:47:23.1940 Keyfactor.Orchestrators.JobExecutors.OrchestratorJobExecutor [Debug] - Response status code does not indicate success: 413 (Request Entity Too Large).

at System.Net.Http.HttpResponseMessage.EnsureSuccessStatusCode() in /_/src/System.Net.Http/src/System/Net/Http/HttpResponseMessage.cs:line 172

at Keyfactor.Orchestrators.Services.HttpService.SendPostAsync[T](String uri, Object requestData, Dictionary`2 headers) in F:\BuildAgents\Default1\_work\24\s\src\OrchestratorServices\HttpService.cs:line 38

This indicates that the amount of data being returned on the job is greater than IIS on the Keyfactor Command server is configured to accept. You will need to make modifications to the IIS settings on your Keyfactor Command server to allow it to accept larger incoming pieces of content. See Fetch Logs for more information.

Table 600: GET Orchestrator Jobs Job Status Data Input Parameters

Name In Description
jobHistoryId Query

Required. The Keyfactor Command reference ID of the orchestrator job.

Use the GET Orchestrator Jobs Job History operation to retrieve a list of jobs to determine the job's history ID.

Table 601: GET Orchestrator Jobs Job Status Data Response Data

Name Description
JobHistoryId An integer indicate the Keyfactor Command reference ID used to track progress during orchestrator jobs.
Data A string containing up to 2 MB of data returned from the custom job.
Tip:  See 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. Reference and Utility, which allows you to call API operations and view results. It is primarily intended 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, and also serves as an interactive supplement to this API documentation. You can access it from the help menu () in the Management Portal.