TeamCity 2021.1 Help

AgentApi

getAllAgents

Get all known agents.

Endpoint

/app/rest/agents

HTTP method

GET

Produces

  • application/xml
  • application/json

Parameters

Response

Agents

deleteAgent

Delete an inactive agent.

Endpoint

/app/rest/agents/{agentLocator}

HTTP method

DELETE

Parameters

getAgent

Get agent matching the locator.

Endpoint

/app/rest/agents/{agentLocator}

HTTP method

GET

Produces

  • application/xml
  • application/json

Parameters

Response

Agent

getAuthorizedInfo

Get the authorization info of the matching agent.

Endpoint

/app/rest/agents/{agentLocator}/authorizedInfo

HTTP method

GET

Produces

  • application/xml
  • application/json

Parameters

Response

AuthorizedInfo

setAuthorizedInfo

Update the authorization info of the matching agent.

Endpoint

/app/rest/agents/{agentLocator}/authorizedInfo

HTTP method

PUT

Consumes

  • application/xml
  • application/json

Produces

  • application/xml
  • application/json

Parameters

Response

AuthorizedInfo

getBuildConfigurationRunPolicy

Get the build configuration run policy of the matching agent.

Endpoint

/app/rest/agents/{agentLocator}/compatibilityPolicy

HTTP method

GET

Produces

  • application/xml
  • application/json

Parameters

Response

CompatibilityPolicy

setBuildConfigurationRunPolicy

Update build configuration run policy of agent matching locator.

Endpoint

/app/rest/agents/{agentLocator}/compatibilityPolicy

HTTP method

PUT

Consumes

  • application/xml
  • application/json

Produces

  • application/xml
  • application/json

Parameters

Response

CompatibilityPolicy

getCompatibleBuildTypes

Get build types compatible with the matching agent.

Endpoint

/app/rest/agents/{agentLocator}/compatibleBuildTypes

HTTP method

GET

Produces

  • application/xml
  • application/json

Parameters

Response

BuildTypes

getEnabledInfo

Check if the matching agent is enabled.

Endpoint

/app/rest/agents/{agentLocator}/enabledInfo

HTTP method

GET

Produces

  • application/xml
  • application/json

Parameters

Response

EnabledInfo

setEnabledInfo

Update the enablement status of the matching agent.

Endpoint

/app/rest/agents/{agentLocator}/enabledInfo

HTTP method

PUT

Consumes

  • application/xml
  • application/json

Produces

  • application/xml
  • application/json

Parameters

Response

EnabledInfo

getIncompatibleBuildTypes

Get build types incompatible with the matching agent.

Endpoint

/app/rest/agents/{agentLocator}/incompatibleBuildTypes

HTTP method

GET

Produces

  • application/xml
  • application/json

Parameters

Response

Compatibilities

getAgentPool

Get the agent pool of the matching agent.

Endpoint

/app/rest/agents/{agentLocator}/pool

HTTP method

GET

Produces

  • application/xml
  • application/json

Parameters

Response

AgentPool

setAgentPool

Assign the matching agent to the specified agent pool.

Endpoint

/app/rest/agents/{agentLocator}/pool

HTTP method

PUT

Consumes

  • application/xml
  • application/json

Produces

  • application/xml
  • application/json

Parameters

Response

AgentPool

getAgentField

Get a field of the matching agent.

Endpoint

/app/rest/agents/{agentLocator}/{field}

HTTP method

GET

Produces

  • text/plain

Parameters

Response

string

setAgentField

Update a field of the matching agent.

Endpoint

/app/rest/agents/{agentLocator}/{field}

HTTP method

PUT

Consumes

  • text/plain

Produces

  • text/plain

Parameters

Response

string

Last modified: 20 February 2021