TeamCity REST API Reference
 
2024.07
  1. Autogenerated REST API Reference
  2. Methods
  3. AgentPoolApi

AgentPoolApi

Last modified: 30 March 2022

getAllAgentPools

Get all agent pools.

Endpoint

GET
/app/rest/agentPools

Produces

  • application/xml

  • application/json

Parameters

Response

AgentPools

createAgentPool

Create a new agent pool.

Endpoint

POST
/app/rest/agentPools

Consumes

  • application/xml

  • application/json

Produces

  • application/xml

  • application/json

Parameters

Response

AgentPool

deleteAgentPool

Delete the agent pool matching the locator.

Endpoint

DELETE
/app/rest/agentPools/{agentPoolLocator}

Parameters

getAgentPoolOfAgentPool

Get the agent pool matching the locator.

Endpoint

GET
/app/rest/agentPools/{agentPoolLocator}

Produces

  • application/xml

  • application/json

Parameters

Response

AgentPool

getAllAgentsFromAgentPool

Get the agent of the matching agent pool.

Endpoint

GET
/app/rest/agentPools/{agentPoolLocator}/agents

Produces

  • application/xml

  • application/json

Parameters

Response

Agents

addAgentToAgentPool

Assign the agent to the matching agent pool.

Endpoint

POST
/app/rest/agentPools/{agentPoolLocator}/agents

Consumes

  • application/xml

  • application/json

Produces

  • application/xml

  • application/json

Parameters

Response

Agent

deleteAllProjectsFromAgentPool

Unassign all projects from the matching agent pool.

Endpoint

DELETE
/app/rest/agentPools/{agentPoolLocator}/projects

Parameters

getAllProjectsFromAgentPool

Get all projects of the matching agent pool.

Endpoint

GET
/app/rest/agentPools/{agentPoolLocator}/projects

Produces

  • application/xml

  • application/json

Parameters

Response

Projects

addProjectToAgentPool

Assign the project to the matching agent pool.

Endpoint

POST
/app/rest/agentPools/{agentPoolLocator}/projects

Consumes

  • application/xml

  • application/json

Produces

  • application/xml

  • application/json

Parameters

Response

Project

setAgentPoolProjects

Update projects of the matching agent pool.

Endpoint

PUT
/app/rest/agentPools/{agentPoolLocator}/projects

Consumes

  • application/xml

  • application/json

Produces

  • application/xml

  • application/json

Parameters

Response

Projects

deleteProjectFromAgentPool

Unassign the project from the matching agent pool.

Endpoint

DELETE
/app/rest/agentPools/{agentPoolLocator}/projects/{projectLocator}

Parameters

getFieldFromAgentPool

Get a field of the matching agent pool.

Endpoint

GET
/app/rest/agentPools/{agentPoolLocator}/{field}

Produces

  • text/plain

Parameters

Response

string

setAgentPoolField

Update a field of the matching agent pool.

Endpoint

PUT
/app/rest/agentPools/{agentPoolLocator}/{field}

Consumes

  • text/plain

Produces

  • text/plain

Parameters

Response

string