TeamCity 2020.2 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

DimensionData typeFormatDescription

authorized

boolean

Is the agent authorized.

build

string

BuildLocator

Build locator.

compatible

string

BuildTypeLocator

Compatible build types locator.

connected

boolean

Is the agent connected.

count

integer

int32

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

enabled

boolean

Is the agent enabled.

id

integer

int32

Entity ID.

ip

string

item

string

item:(<locator1>),item:(<locator2>...)

Supply multiple locators and return a union of the results.

name

string

parameter

string

pool

string

AgentPoolLocator

Agent pool locator.

start

integer

int32

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

Last modified: 20 February 2021