List connector pools

This lists connector pools for the account, including pools with no connectors. To list only pools that have connectors, set contain_connectors. By default, the response paginates. To get the matching pools in a bare array with no meta or objects wrapper, set all. Without limit the array holds at most 1000 pools. With limit it holds at most limit pools, never more than 1000. The offset parameter still applies.

Query Params
string
required

The Akamai contract identifier for your Enterprise Application Access product.

integer
≥ 0

The number of connector pools to include on each page of results, 20 by default. If you set it to 0 or to more than 1000, the API returns 1000 connector pools.

integer
≥ 0
Defaults to 0

The number of results to skip before the first result, starting at the default 0.

string

Specifying any value returns the matching connector pools as a bare JSON array with no meta or objects wrapper. Without limit, the array holds at most 1000 pools. With limit it holds at most limit pools, never more than 1000. The offset parameter still applies. If you also set contain_connectors, that parameter's rules for filtering apply.

string

Specifying any value returns only connector pools that have at least one connector. When enabled, only the infra_type and infra_type__ne filters apply, and infra_type accepts a single value rather than a comma-separated list. All other filters are ignored.

string

Filters connector pools by exact name. To match a prefix or a substring, use name__startswith or name__icontains instead.

string

Filters connector pools by exact description. To match a prefix or a substring, use description__startswith or description__icontains instead.

string
enum

Enum Filters connector pools by localization. Either DF for default or CN for China.

Allowed:
integer
enum

Enum Filters connector pools by package type. Refer to Connector package types for a complete list.

infra_type
array of integers

Filters connector pools by infrastructure type. Either 1, 2, 3, or 4. Provide multiple values as a comma-separated list, for example 1,2. If you also set contain_connectors, provide only one value.

infra_type
Allowed:
integer

Excludes connector pools with the specified infrastructure type. Either 1, 2, 3, or 4.

string

Filters connector pools that contain a connector whose name includes this value. The match is case insensitive.

string

Filters connector pools associated with a directory whose name includes this value. The match is case insensitive.

string

Filters connector pools associated with an enterprise DNS entry whose name includes this value. The match is case insensitive.

string

Filters connector pools by the name of an application access group they're a member of. The match includes partial names and is case insensitive.

string

Filters connector pools by the UUID URL of an application access group they're a member of. This is ignored if you also set aag_name.

string

Filters connector pools by the name of an associated application. The match includes the value and is case insensitive. If any matching application belongs to an application access group, the response includes only pools reached through those access groups. Otherwise it includes pools associated directly with the matching applications.

string
enum

Enum The field to sort by. Either name, created_at, or modified_at. Sorting only applies if you also set order. If you also set order, any other value causes a 400 error.

Allowed:
string
enum

Enum Set to desc to sort in descending order. Any other value, or omitting the parameter, sorts in ascending order. Sorting only applies if you also set sort_by.

Allowed:
string

For customers who manage more than one account, this runs the operation from another account. The Identity and Access Management API provides a list of available account switch keys.

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Language
URL
LoadingLoading…
Response
Choose an example:
application/json
application/problem+json