SCscalr
agent-pools

List Agent Pools

Changed on

This endpoint returns a list of agent pools by various filters.

get/agent-pools

Request

  • Base URL
    https://example.scalr.io/api/iacp/v3
  • URL
    https://example.scalr.io/api/iacp/v3/agent-pools
  • Auth
    HTTP bearer

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.

accountsstring

The comma-separated list of fields to return in response for Account resource.

agent-poolsstring

The comma-separated list of fields to return in response for AgentPool resource.

agentsstring

The comma-separated list of fields to return in response for Agent resource.

environmentsstring

The comma-separated list of fields to return in response for Environment resource.

workspacesstring

The comma-separated list of fields to return in response for Workspace resource.

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.

includedobject[]
linksobject
metaobject

Changes

  • d3e1dc85657aRevision changes
    • info

      added the optional property /// to the response with the status

    • info

      added the optional property /// to the response with the status