Skip to main content
Version: 0.6.0

Agent Pools

An Agent Pool is a named collection of tfc-agent processes. Pools are scoped to an organization and can be assigned to specific workspaces for execution.

Available Queries

QueryDescription
agentPools(includeOrgs, excludeOrgs, filter: AgentPoolFilter)List pools across organizations
agentPool(id: ID!)Fetch a single pool by ID

Example

query AllAgentPools {
agentPools(includeOrgs: ["my-org"]) {
id
name
agentCount
organizationScoped
agents {
id
name
status
}
workspaces {
id
name
}
}
}

Fields

FieldTypeDescription
idID!Pool identifier
typeString!Resource type
nameString!Pool name
createdAtDateTime!When the pool was created
organizationScopedBoolean!Whether the pool is available to all workspaces in the org
agentCountInt!Number of agents currently in the pool
workspaces[Workspace!]!Workspaces assigned to this pool
allowedWorkspaces[Workspace!]!Workspaces explicitly allowed to use this pool
agents[Agent!]!Agents registered to this pool
authenticationTokens[AgentToken!]!Tokens for this pool

Filter Fields

FieldComparison Type
idStringComparisonExp
typeStringComparisonExp
nameStringComparisonExp
createdAtDateTimeComparisonExp
organizationScopedBooleanComparisonExp
agentCountIntComparisonExp
  • Agents — Individual agent processes in the pool
  • Agent Tokens — Authentication tokens for this pool
  • Workspaces — Workspaces assigned to this pool