TeamCity REST API Reference 2025.03 Help

AgentLocator

Represents a locator string for filtering Agent entities. Examples:

  • name:DefaultAgent - find agent with DefaultAgent name.

  • pool:(<agentPoolLocator>),connected:true - find all connected agents in a pool found by agentPoolLocator.

Properties

Dimension

Data type

Format

Description

$singleValue

string

String value

Agent name.

authorized

string

Is the agent authorized.

Supported values:

  • true

  • false

  • any

build

string

BuildLocator

Build locator which run on this agent (or is compatible with for queued builds).

compatible

string

CompatibleDimensions

Compatible build types locator.

connected

string

Is the agent connected.

Supported values:

  • true

  • false

  • any

count

long

int64

For paginated calls, how many entities to return per page.

enabled

string

Is the agent enabled.

Supported values:

  • true

  • false

  • any

id

long

int64

Agent id.

ip

string

String value

Agent ip address

name

string

String value

Agent name.

parameter

string

Parameter condition.

Matching parameter.

pool

string

AgentPoolDimensions

Agent pool locator.

start

long

int64

For paginated calls, from which entity to start rendering the page.

Last modified: 14 March 2025