TeamCity 2020.2 Help

ProjectApi

getAllProjects

Get all projects.

Endpoint

/app/rest/projects

HTTP method

GET

Produces

  • application/xml
  • application/json

Parameters

  • locator: string
  • fields: string

Response

Projects

addProject

Create a new project.

Endpoint

/app/rest/projects

HTTP method

POST

Consumes

  • application/xml
  • application/json

Produces

  • application/xml
  • application/json

Parameters

Response

Project

deleteProject

Delete project matching the locator.

Endpoint

/app/rest/projects/{projectLocator}

HTTP method

DELETE

Parameters

getProject

Get project matching the locator.

Endpoint

/app/rest/projects/{projectLocator}

HTTP method

GET

Produces

  • application/xml
  • application/json

Parameters

Response

Project

getAgentPoolsProject

Get agent pools appointed to the matching project.

Endpoint

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

HTTP method

GET

Produces

  • application/xml
  • application/json

Parameters

Response

AgentPools

addAgentPoolsProject

Assign the matching project to the agent pool.

Endpoint

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

HTTP method

POST

Consumes

  • application/xml
  • application/json

Produces

  • application/xml
  • application/json

Parameters

Response

AgentPool

setAgentPoolsProject

Update agent pools apppointed to the matching project.

Endpoint

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

HTTP method

PUT

Consumes

  • application/xml
  • application/json

Produces

  • application/xml
  • application/json

Parameters

Response

AgentPools

removeProjectFromAgentPool

Unassign a project from the matching agent pool.

Endpoint

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

HTTP method

DELETE

Parameters

getAllBranches

Get all branches of the matching project.

Endpoint

/app/rest/projects/{projectLocator}/branches

HTTP method

GET

Produces

  • application/xml
  • application/json

Parameters

Response

Branches

addBuildType

Add a build configuration to the matching project.

Endpoint

/app/rest/projects/{projectLocator}/buildTypes

HTTP method

POST

Consumes

  • application/xml
  • application/json

Produces

  • application/xml
  • application/json

Parameters

Response

BuildType

removeDefaultTemplate

Remove the default template from the matching project.

Endpoint

/app/rest/projects/{projectLocator}/defaultTemplate

HTTP method

DELETE

Parameters

getDefaultTemplate

Get the default template of the matching project.

Endpoint

/app/rest/projects/{projectLocator}/defaultTemplate

HTTP method

GET

Produces

  • application/xml
  • application/json

Parameters

Response

BuildType

setDefaultTemplate

Update the default template of the matching project.

Endpoint

/app/rest/projects/{projectLocator}/defaultTemplate

HTTP method

PUT

Consumes

  • application/xml
  • application/json

Produces

  • application/xml
  • application/json

Parameters

Response

BuildType

setBuildTypesOrder

Update all build configurations order of the matching project.

Endpoint

/app/rest/projects/{projectLocator}/order/buildTypes

HTTP method

PUT

Consumes

  • application/xml
  • application/json

Produces

  • application/xml
  • application/json

Parameters

Response

BuildTypes

getAllSubprojectsOrdered

Get all subprojects ordered of the matching project.

Endpoint

/app/rest/projects/{projectLocator}/order/projects

HTTP method

GET

Produces

  • application/xml
  • application/json

Parameters

Response

Projects

setSubprojectsOrder

Update all subprojects order of the matching project.

Endpoint

/app/rest/projects/{projectLocator}/order/projects

HTTP method

PUT

Consumes

  • application/xml
  • application/json

Produces

  • application/xml
  • application/json

Parameters

Response

Projects

deleteBuildParameters

Delete all build parameters.

Endpoint

/app/rest/projects/{projectLocator}/parameters

HTTP method

DELETE

Parameters

getBuildParameters

Get build parameters.

Endpoint

/app/rest/projects/{projectLocator}/parameters

HTTP method

GET

Produces

  • application/xml
  • application/json

Parameters

Response

Properties

createBuildParameter

Create a build parameter.

Endpoint

/app/rest/projects/{projectLocator}/parameters

HTTP method

POST

Consumes

  • application/xml
  • application/json

Produces

  • application/xml
  • application/json

Parameters

Response

Property

updateBuildParameters

Update build parameters.

Endpoint

/app/rest/projects/{projectLocator}/parameters

HTTP method

PUT

Consumes

  • application/xml
  • application/json

Produces

  • application/xml
  • application/json

Parameters

Response

Properties

deleteBuildParameter

Delete build parameter.

Endpoint

/app/rest/projects/{projectLocator}/parameters/{name}

HTTP method

DELETE

Parameters

getBuildParameter

Get build parameter.

Endpoint

/app/rest/projects/{projectLocator}/parameters/{name}

HTTP method

GET

Produces

  • application/xml
  • application/json

Parameters

Response

Property

updateBuildParameter

Update build parameter.

Endpoint

/app/rest/projects/{projectLocator}/parameters/{name}

HTTP method

PUT

Consumes

  • application/xml
  • application/json

Produces

  • application/xml
  • application/json

Parameters

Response

Property

getBuildParameterType

Get type of build parameter.

Endpoint

/app/rest/projects/{projectLocator}/parameters/{name}/type

HTTP method

GET

Produces

  • application/xml
  • application/json

Parameters

Response

Type

updateBuildParameterType

Update type of build parameter.

Endpoint

/app/rest/projects/{projectLocator}/parameters/{name}/type

HTTP method

PUT

Consumes

  • application/xml
  • application/json

Produces

  • application/xml
  • application/json

Parameters

Response

Type

getBuildParameterSpecification

Get build parameter specification.

Endpoint

/app/rest/projects/{projectLocator}/parameters/{name}/type/rawValue

HTTP method

GET

Produces

  • text/plain

Parameters

Response

string

updateBuildParameterSpecification

Update build parameter specification.

Endpoint

/app/rest/projects/{projectLocator}/parameters/{name}/type/rawValue

HTTP method

PUT

Consumes

  • text/plain

Produces

  • text/plain

Parameters

Response

string

getBuildParameterValue

Get value of build parameter.

Endpoint

/app/rest/projects/{projectLocator}/parameters/{name}/value

HTTP method

GET

Produces

  • text/plain

Parameters

Response

string

updateBuildParameterValue

Update value of build parameter.

Endpoint

/app/rest/projects/{projectLocator}/parameters/{name}/value

HTTP method

PUT

Consumes

  • text/plain

Produces

  • text/plain

Parameters

Response

string

getProjectParentProject

Get the parent project of the matching project.

Endpoint

/app/rest/projects/{projectLocator}/parentProject

HTTP method

GET

Produces

  • application/xml
  • application/json

Parameters

Response

Project

setParentProject

Update the parent project of the matching project.

Endpoint

/app/rest/projects/{projectLocator}/parentProject

HTTP method

PUT

Consumes

  • application/xml
  • application/json

Produces

  • application/xml
  • application/json

Parameters

Response

Project

getFeatures

Get all features.

Endpoint

/app/rest/projects/{projectLocator}/projectFeatures

HTTP method

GET

Produces

  • application/xml
  • application/json

Parameters

Response

object

addFeature

Add a feature.

Endpoint

/app/rest/projects/{projectLocator}/projectFeatures

HTTP method

POST

Consumes

  • application/xml
  • application/json

Produces

  • application/xml
  • application/json

Parameters

Response

object

updateFeatures

Update all features.

Endpoint

/app/rest/projects/{projectLocator}/projectFeatures

HTTP method

PUT

Consumes

  • application/xml
  • application/json

Produces

  • application/xml
  • application/json

Parameters

Response

object

deleteFeature

Delete a matching feature.

Endpoint

/app/rest/projects/{projectLocator}/projectFeatures/{featureLocator}

HTTP method

DELETE

Parameters

getFeature

Get a matching feature.

Endpoint

/app/rest/projects/{projectLocator}/projectFeatures/{featureLocator}

HTTP method

GET

Produces

  • application/xml
  • application/json

Parameters

Response

object

updateFeature

Update a matching feature.

Endpoint

/app/rest/projects/{projectLocator}/projectFeatures/{featureLocator}

HTTP method

PUT

Consumes

  • application/xml
  • application/json

Produces

  • application/xml
  • application/json

Parameters

Response

object

addSecureToken

Create a new secure token for the matching project.

Endpoint

/app/rest/projects/{projectLocator}/secure/tokens

HTTP method

POST

Consumes

  • text/plain

Produces

  • text/plain

Parameters

Response

string

getSecureValue

Get a secure token of the matching project.

Endpoint

/app/rest/projects/{projectLocator}/secure/values/{token}

HTTP method

GET

Consumes

  • text/plain

Produces

  • text/plain

Parameters

Response

string

getProjectSettingsFile

Get the settings file of the matching build configuration.

Endpoint

/app/rest/projects/{projectLocator}/settingsFile

HTTP method

GET

Produces

  • text/plain

Parameters

Response

string

getProjectTemplates

Get all templates of the matching project.

Endpoint

/app/rest/projects/{projectLocator}/templates

HTTP method

GET

Produces

  • application/xml
  • application/json

Parameters

Response

BuildTypes

addTemplate

Add a build configuration template to the matching project.

Endpoint

/app/rest/projects/{projectLocator}/templates

HTTP method

POST

Consumes

  • application/xml
  • application/json

Produces

  • application/xml
  • application/json

Parameters

Response

BuildType

getProjectField

Get a field of the matching project.

Endpoint

/app/rest/projects/{projectLocator}/{field}

HTTP method

GET

Produces

  • text/plain

Parameters

Response

string

setProjectField

Update a field of the matching project.

Endpoint

/app/rest/projects/{projectLocator}/{field}

HTTP method

PUT

Consumes

  • text/plain

Produces

  • text/plain

Parameters

Response

string

Last modified: 20 February 2021