PUT Agent Pools

The PUT /AgentPools method is used to update an existing 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 Roles and Claims) are required to use this feature:

/ssl/read/
/ssl/modify/

Important:  Any previously populated fields that are not submitted with their full existing data using this method will be cleared of their existing data. When using this method, you should first do a GET to retrieve all the values for the record you want to update, enter corrected data into the field(s) you want to update, and then submit all the fields using PUT, including the fields that contain values but which you are not changing.

Table 182: PUT Agent Pools Input Parameters

Name In Description
AgentPoolId Body Required. A string indicating the GUID of the orchestrator pool that is to be updated.
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 183: PUT Agent Pools 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. ClosedShow orchestrator details.
Tip:  See the Keyfactor API Reference and Utility which provides a utility through which 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. endpoints can be called and results returned. It is intended to be used primarily 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. 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.