POST Agent Pools

The POST /AgentPools method is used to create a new 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 information about the orchestrator pool.

Tip:  The following permissions (see Security Overview) are required to use this feature:

SslManagement: Read
SslManagement: Modify

Table 97: POST AgentPools Input Parameters

Name In Description
Name Body Required. A string indicating the name of the orchestrator pool.

Agents

 Body

A list of orchestrators that will be part of this orchestrator pool. The orchestrators must not be assigned to a different orchestrator pool (except the Default Agent Pool). ClosedShow per-orchestrator data.

Table 98: POST AgentPools 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.