GET /api/v1/agentPools

Lists all agent pools with pagination support

Servers

Query parameters

Name Type Required Description
poolType String No

Agent type to search for

Possible values:

  • "IWA"
  • "OPP"
  • "Radius"
  • "LDAP"
  • "AD"
  • "MFA"
  • "RUM"
after String No

The cursor to use for pagination. It is an opaque string that specifies your current location in the list and is obtained from the Link response header. See Pagination.

limitPerPoolType Integer No

Maximum number of AgentPools being returned

Default value: 5

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.