Create an Agent Pool

Create a new agent pool resource.

Agent pools can be created at the account or environment scope. The scope must be defined as part of the agent pool creation. If a pool is created at the account scope, all environments and workspaces within those environments will have access to use the pool. If a pool is created at the environment scope, then only the workspaces in that environment can use that pool.

The typical flow for configuring a new agent pool involves the following operations:

  • Create an agent pool
  • Create an access token for the pool. The pool token is needed by an agent in order to join the agent pool. During the agent<->server handshake phase, the API server will generate a unique session token for each agent which will be used for all communication with the API server.
  • Install/Configure an agent on the customer's network.
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
include
array of strings

The comma-separated list of relationship paths.

include
Body Params
data
object

With the agent pool resource you can manage a pool of self-hosted agents

A workspace may be configured to use an agent pool to execute terraform runs. Agents could be hosted on a physical or virtual machines within the customer's network.

Responses

403

User unauthorized to perform this action.

409

Quota exceeded error.

422

Malformed request body (missing attributes, wrong types, etc.).

4XX

Client error.

5XX

Server error.

Language
Credentials
Bearer
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/vnd.api+json