TeamCity REST API Reference
 
2023.05
You are viewing the documentation for an earlier version of TeamCity REST API Reference.
  1. Autogenerated REST API Reference
  2. Methods
  3. AgentApi

AgentApi

Last modified: 30 March 2022

getAllAgents

Get all known agents.

Endpoint

GET
/app/rest/agents

Produces

  • application/xml

  • application/json

Parameters

Response

Agents

deleteAgent

Delete an inactive agent.

Endpoint

DELETE
/app/rest/agents/{agentLocator}

Parameters

getAgent

Get agent matching the locator.

Endpoint

GET
/app/rest/agents/{agentLocator}

Produces

  • application/xml

  • application/json

Parameters

Response

Agent

getAuthorizedInfo

Get the authorization info of the matching agent.

Endpoint

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

Produces

  • application/xml

  • application/json

Parameters

Response

AuthorizedInfo

setAuthorizedInfo

Update the authorization info of the matching agent.

Endpoint

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

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

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

Produces

  • application/xml

  • application/json

Parameters

Response

CompatibilityPolicy

setBuildConfigurationRunPolicy

Update build configuration run policy of agent matching locator.

Endpoint

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

Consumes

  • application/xml

  • application/json

Produces

  • application/xml

  • application/json

Parameters

Response

CompatibilityPolicy

getCompatibleBuildTypes

Get build types compatible with the matching agent.

Endpoint

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

Produces

  • application/xml

  • application/json

Parameters

Response

BuildTypes

getEnabledInfo

Check if the matching agent is enabled.

Endpoint

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

Produces

  • application/xml

  • application/json

Parameters

Response

EnabledInfo

setEnabledInfo

Update the enablement status of the matching agent.

Endpoint

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

Consumes

  • application/xml

  • application/json

Produces

  • application/xml

  • application/json

Parameters

Response

EnabledInfo

getIncompatibleBuildTypes

Get build types incompatible with the matching agent.

Endpoint

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

Produces

  • application/xml

  • application/json

Parameters

Response

Compatibilities

getAgentPool

Get the agent pool of the matching agent.

Endpoint

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

Produces

  • application/xml

  • application/json

Parameters

Response

AgentPool

setAgentPool

Assign the matching agent to the specified agent pool.

Endpoint

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

Consumes

  • application/xml

  • application/json

Produces

  • application/xml

  • application/json

Parameters

Response

AgentPool

getAgentField

Get a field of the matching agent.

Endpoint

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

Produces

  • text/plain

Parameters

Response

string

setAgentField

Update a field of the matching agent.

Endpoint

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

Consumes

  • text/plain

Produces

  • text/plain

Parameters

Response

string