GET Agent Pools

The GET /AgentPools method is used to retrieve all orchestratorClosed Keyfactor orchestrators perform a variety of functions, including managing certificate stores and SSH key stores. (a.k.a. agent) pools. This method returns HTTP 200 OK on a success with a list of all agent pool details.

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

SslManagement: Read

Table 95: GET AgentPools Input Parameters

Name In Description
queryString Query

A string containing a query to limit the results (e.g. field1 -eq value1 AND field2 -gt value2). The default is to return all records. Fields available for querying through the APIClosed 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. for the most part match those that appear in the Keyfactor Command Management Portal search dropdowns for the same feature. For querying guidelines, refer to the Keyfactor Command Reference Guide: Certificate Search Page. The query fields supported for this endpointClosed An endpoint is a URL that enables the API to gain access to resources on a server. are:

  • Id (AgentPoolID)
  • Name
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.
sortField Query A string containing the property by which the results should be sorted. Fields available for sorting through the API for the most part match those that appear as sortable columns in the Keyfactor Command Management Portal. 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 96: GET 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.