TeamCity REST API 2020.2 Help

AgentPoolApi

getAllAgentPools

Get all agent pools.

Endpoint

/app/rest/agentPools

HTTP method

GET

Parameters

Response

AgentPools

createAgentPool

Create a new agent pool.

Endpoint

/app/rest/agentPools

HTTP method

POST

Parameters

Response

AgentPool

deleteAgentPool

Delete the agent pool matching the locator.

Endpoint

/app/rest/agentPools/{agentPoolLocator}

HTTP method

DELETE

Parameters

getAgentPoolOfAgentPool

Get the agent pool matching the locator.

Endpoint

/app/rest/agentPools/{agentPoolLocator}

HTTP method

GET

Parameters

Response

AgentPool

getAllAgentsFromAgentPool

Get the agent of the matching agent pool.

Endpoint

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

HTTP method

GET

Parameters

Response

Agents

addAgentToAgentPool

Assign the agent to the matching agent pool.

Endpoint

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

HTTP method

POST

Parameters

Response

Agent

deleteAllProjectsFromAgentPool

Unassign all projects from the matching agent pool.

Endpoint

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

HTTP method

DELETE

Parameters

getAllProjectsFromAgentPool

Get all projects of the matching agent pool.

Endpoint

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

HTTP method

GET

Parameters

Response

Projects

addProjectToAgentPool

Assign the project to the matching agent pool.

Endpoint

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

HTTP method

POST

Parameters

Response

Project

setAgentPoolProjects

Update projects of the matching agent pool.

Endpoint

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

HTTP method

PUT

Parameters

Response

Projects

deleteProjectFromAgentPool

Unassign the project from the matching agent pool.

Endpoint

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

HTTP method

DELETE

Parameters

getFieldFromAgentPool

Get a field of the matching agent pool.

Endpoint

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

HTTP method

GET

Parameters

Response

string

setAgentPoolField

Update a field of the matching agent pool.

Endpoint

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

HTTP method

PUT

Parameters

Response

string

Last modified: 21 December 2020