SCscalr
agent-pools

Get an Agent Pool

Changed on

Show details of a specific agent pool.

get/agent-pools/{agent_pool}

Request

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

Path parameters

agent_poolstring required

The ID of the agent pool to show.

Query parameters

includestring[]

The comma-separated list of relationship paths.

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[]
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