agent-pools
List Agent Pools
This endpoint returns a list of agent pools by various filters.
get/agent-pools
Query parameters
querystring
Query string, search by ID or name.
filter[agent-pool]string
The id of the agent pool.
filter[name]string
The agent pool name.
filter[vcs-enabled]string
Is the agent pool VCS support enabled.
filter[in-use]string
Is the agent pool is used by any workspace.
filter[is-shared]string
Is the agent pool shared with all environments.
filter[account]string
The account filter.
filter[environment]string
The environment filter.
page[number]string
Page number
page[size]string
Page size
includestring[]
The comma-separated list of relationship paths.
sortstring[]
The comma-separated list of attributes.
The value of the fields[resource-type] parameter is a comma-separated list that refers to the name of the fields to be returned for the resource. An empty value indicates that no fields should be returned.
Response
Success.