GET Agent Pools

The GET /AgentPools operation retrieves all SSLClosed TLS (Transport Layer Security) and its predecessor SSL (Secure Sockets Layer) are protocols for establishing authenticated and encrypted links between networked computers. pools for SSL discovery. Query parameters support filtering using defined criteria, control over pagination by specifying the page number and return limit, and customization of sorting based on specified fields and order. On success, the operation returns HTTP 200 OK with  a list of all SSL pool details.

Note:  This operation is not used to manage orchestratorClosed Keyfactor orchestrators perform a variety of functions, including managing certificate stores and SSH key stores. pools. It applies strictly to SSL pools used by SSL discovery and monitoring.
Tip:  The following permissions (see Security Roles and Claims) are required to use this feature:

/ssl/read/

Table 166: GET Agent Pools Input Parameters

Name In Description
QueryString Query

A string containing a query to limit the results (for example, field1 -eq value1 AND field2 -gt value2). The default is to return all records. For querying guidelines, refer to: Using Search in the Management Portal. The query fields supported for this operation 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. Very large values can result in long processing time.
SortField Query

A string containing the property by which the results should be sorted. Fields available for sorting through the API include:

  • AgentPoolId

  • Name

Available sort fields are affected by the query provided in QueryString. 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 167: GET AgentPools Response Data

Name Description
AgentPoolId A string indicating the GUID of the SSL pool.
Name A string indicating the name of the SSL 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 SSL pool, with accompanying data about the orchestrators. ClosedShow orchestrator details.
Tip:  See 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. Reference and Utility, which allows you to call API operations and view results. It is primarily intended 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, and also serves as an interactive supplement to this API documentation. You can access it from the help menu () in the Management Portal.