The GET /AgentPools/{id} method is used to return information about a single orchestrator
Keyfactor orchestrators perform a variety of functions, including managing certificate stores and SSH key stores. (a.k.a. agent) pool. This method returns HTTP 200 OK on a success with details about the requested orchestrator pool.
Tip: The following permissions (see Security Roles and Claims) are required to use this feature:
/ssl/read/
Table 118: GET Agent Pools {id} Input Parameters
| Name | In | Description |
|---|---|---|
| id | Path | Required. A string indicating the GUID of the orchestrator pool to retrieve. Use the GET /AgentPools method (see GET Agent Pools) to retrieve a list of all the orchestrator pools to determine the orchestrator pool GUID. |
Table 119: GET AgentPools {id} Response Data
| Name | Description |
|---|---|
| AgentPoolId | A string indicating the GUID of the orchestrator pool. |
| Name | A string indicating the name of the orchestrator pool. |
| DiscoverAgentsCount | An integer specifying the number of orchestrators in the pool that can perform discovery jobs. |
| MonitorAgentsCount | An integer specifying the number of orchestrators in the pool that can perform monitoring jobs. |
| Agents |
An array of objects containing the orchestrators that are assigned to the orchestrator pool, with accompanying data about the orchestrators. |
Tip: See the Keyfactor API Reference and Utility which provides a utility through which the Keyfactor API 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.
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.