The GET /OrchestratorPools operation retrieves the orchestrator
Keyfactor orchestrators perform a variety of functions, including managing certificate stores and SSH key stores. pools defined in Keyfactor Command. 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 pools.
Table 633: GET Orchestrator Pools 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 Name. |
| 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 634: GET Orchestrator Pools Response Data
| Name |
Description |
|---|---|
| AllowAutoRegistration |
A Boolean that controls whether orchestrators are allowed to automatically register into the pool. When turned on, orchestrators that meet the configured claim requirements can join the pool without manual approval. Important: Auto-registration is successful only when all the following conditions are met:
|
| Capabilities |
An array of strings listing the capabilities assigned to the pool. Both certificate store and custom job capabilities are supported. The capabilities assigned to the pool determine which jobs can be routed to it. Orchestrators can be added to a pool regardless of the capabilities they individually declare. However, jobs executed by the pool are limited to those supported by both the pool and at least one orchestrator in the pool. Important: When using remote PAM providers, ensure that all orchestrators in a pool are configured with the required PAM extensions and supporting files. Jobs assigned to a pool can be executed by any eligible orchestrator in that pool. If some orchestrators support a remote PAM provider and others do not, job execution results may vary depending on which orchestrator receives the job. To avoid inconsistent behavior, either configure all orchestrators in the pool identically or separate orchestrators with different PAM capabilities into different pools.
|
| Claims |
An array of objects indicating the identity claims that are permitted to auto-register orchestrators into the pool. |
| Description | A string indicating a description that provides additional context about the purpose or usage of the orchestrator pool. |
| Id | A string indicating the Keyfactor Command reference GUID of the orchestrator pool. |
| JobTimeout |
An integer indicating the maximum amount of time, in minutes, a job is allowed to run before it is considered timed out. |
| LastSeenThreshold |
An integer that defines how long, in minutes, an orchestrator can go without registering before it is automatically removed from the pool. This value must be greater than the RegistrationInterval. If RemoveTransientOrchestrators is False, this value is not relevant. |
| Name | A string indicating the unique, user-defined name of the orchestrator pool. |
| NumberOfOrchestrators | An integer indicating the number orchestrators in the pool. |
| RegistrationInterval |
An integer that specifies how frequently, in minutes, orchestrators in the pool register with Keyfactor Command to request new work and report job status. This setting replaces the legacy heartbeat interval. |
| RemoveTransientOrchestrators |
A Boolean that controls whether orchestrators are automatically removed from the pool if they have not registered with Keyfactor Command within the configured LastSeenThreshold. |
| RetryPauseInterval |
An integer that specifies how long, in minutes, Keyfactor Command waits before rescheduling a job that completed with a retryable status. This prevents retryable jobs from being immediately reassigned. |
| SessionJobLimit |
An integer that indicates the limit on the number of jobs that Keyfactor Command assigns to an orchestrator during a single registration cycle. |
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