GET Agent Pools ID

The GET /AgentPools/{id} method is used to return information about a single orchestratorClosed 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 Overview) are required to use this feature:

SslManagement: Read

Table 93: GET AgentPools {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 94: 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 containing the orchestrators that are assigned to the orchestrator pool, with accompanying data about the orchestrators. ClosedShow orchestrator details.