TeamCity REST API Reference 2021.2 Help

BuildTypeApi

getAllBuildTypes

Get all build configurations.

Endpoint

/app/rest/buildTypes

Produces

  • application/xml

  • application/json

Parameters

Response

BuildTypes

createBuildType

Create a new build configuration.

Endpoint

/app/rest/buildTypes

Consumes

  • application/xml

  • application/json

Produces

  • application/xml

  • application/json

Parameters

Response

BuildType

deleteBuildType

Delete build configuration matching the locator.

Endpoint

/app/rest/buildTypes/{btLocator}

Parameters

getBuildType

Get build configuration matching the locator.

Endpoint

/app/rest/buildTypes/{btLocator}

Produces

  • application/xml

  • application/json

Parameters

Response

BuildType

getAllAgentRequirements

Get all agent requirements of the matching build configuration.

Endpoint

/app/rest/buildTypes/{btLocator}/agent-requirements

Produces

  • application/xml

  • application/json

Parameters

Response

AgentRequirements

addAgentRequirementToBuildType

Add an agent requirement to the matching build configuration.

Endpoint

/app/rest/buildTypes/{btLocator}/agent-requirements

Consumes

  • application/xml

  • application/json

Produces

  • application/xml

  • application/json

Parameters

Response

AgentRequirement

replaceAllAgentRequirements

Update all agent requirements of the matching build configuration.

Endpoint

/app/rest/buildTypes/{btLocator}/agent-requirements

Consumes

  • application/xml

  • application/json

Produces

  • application/xml

  • application/json

Parameters

Response

AgentRequirements

deleteAgentRequirement

Remove an agent requirement of the matching build configuration.

Endpoint

/app/rest/buildTypes/{btLocator}/agent-requirements/{agentRequirementLocator}

Parameters

getAgentRequirement

Get an agent requirement of the matching build configuration.

Endpoint

/app/rest/buildTypes/{btLocator}/agent-requirements/{agentRequirementLocator}

Produces

  • application/xml

  • application/json

Parameters

Response

AgentRequirement

replaceAgentRequirement

Update an agent requirement of the matching build configuration.

Endpoint

/app/rest/buildTypes/{btLocator}/agent-requirements/{agentRequirementLocator}

Consumes

  • application/xml

  • application/json

Produces

  • application/xml

  • application/json

Parameters

Response

AgentRequirement

getAgentRequirementParameter

Get a setting of an agent requirement of the matching build configuration.

Endpoint

/app/rest/buildTypes/{btLocator}/agent-requirements/{agentRequirementLocator}/{fieldName}

Produces

  • text/plain

Parameters

Response

string

setAgentRequirementParameter

Update a parameter of an agent requirement of the matching build configuration.

Endpoint

/app/rest/buildTypes/{btLocator}/agent-requirements/{agentRequirementLocator}/{fieldName}

Consumes

  • text/plain

Produces

  • text/plain

Parameters

  • btLocator: string<BuildTypeLocator>

  • agentRequirementLocator: string

  • fieldName: string

  • body: string

Response

string

getAliases

Get external IDs of the matching build configuration.

Endpoint

/app/rest/buildTypes/{btLocator}/aliases

Produces

  • application/xml

  • application/json

Parameters

Response

Items

getAllArtifactDependencies

Get all artifact dependencies of the matching build configuration.

Endpoint

/app/rest/buildTypes/{btLocator}/artifact-dependencies

Produces

  • application/xml

  • application/json

Parameters

Response

ArtifactDependencies

addArtifactDependencyToBuildType

Add an artifact dependency to the matching build configuration.

Endpoint

/app/rest/buildTypes/{btLocator}/artifact-dependencies

Consumes

  • application/xml

  • application/json

Produces

  • application/xml

  • application/json

Parameters

Response

ArtifactDependency

replaceAllArtifactDependencies

Update all artifact dependencies of the matching build configuration.

Endpoint

/app/rest/buildTypes/{btLocator}/artifact-dependencies

Consumes

  • application/xml

  • application/json

Produces

  • application/xml

  • application/json

Parameters

Response

ArtifactDependencies

deleteArtifactDependency

Remove an artifact dependency from the matching build configuration.

Endpoint

/app/rest/buildTypes/{btLocator}/artifact-dependencies/{artifactDepLocator}

Parameters

getArtifactDependency

Get an artifact dependency of the matching build configuration.

Endpoint

/app/rest/buildTypes/{btLocator}/artifact-dependencies/{artifactDepLocator}

Produces

  • application/xml

  • application/json

Parameters

Response

ArtifactDependency

replaceArtifactDependency

Update an artifact dependency of the matching build configuration.

Endpoint

/app/rest/buildTypes/{btLocator}/artifact-dependencies/{artifactDepLocator}

Consumes

  • application/xml

  • application/json

Produces

  • application/xml

  • application/json

Parameters

Response

ArtifactDependency

getArtifactDependencyParameter

Get a parameter of an artifact dependency of the matching build configuration.

Endpoint

/app/rest/buildTypes/{btLocator}/artifact-dependencies/{artifactDepLocator}/{fieldName}

Produces

  • text/plain

Parameters

Response

string

setArtifactDependencyParameter

Update a parameter of an artifact dependency of the matching build configuration.

Endpoint

/app/rest/buildTypes/{btLocator}/artifact-dependencies/{artifactDepLocator}/{fieldName}

Consumes

  • text/plain

Produces

  • text/plain

Parameters

  • btLocator: string<BuildTypeLocator>

  • artifactDepLocator: string

  • fieldName: string

  • body: string

Response

string

getAllBranchesOfBuildType

Get all branches of the matching build configuration.

Endpoint

/app/rest/buildTypes/{btLocator}/branches

Produces

  • application/xml

  • application/json

Parameters

Response

Branches

getBuildTypeBuildTags

Get tags of builds of the matching build configuration.

Endpoint

/app/rest/buildTypes/{btLocator}/buildTags

Produces

  • application/xml

  • application/json

Parameters

Response

Tags

getBuildTypeBuilds

Get builds of the matching build configuration.

Endpoint

/app/rest/buildTypes/{btLocator}/builds

Produces

  • application/xml

  • application/json

Parameters

Response

Builds

getAllBuildFeatures

Get all build features of the matching build configuration.

Endpoint

/app/rest/buildTypes/{btLocator}/features

Produces

  • application/xml

  • application/json

Parameters

Response

Features

addBuildFeatureToBuildType

Add build feature to the matching build configuration.

Endpoint

/app/rest/buildTypes/{btLocator}/features

Consumes

  • application/xml

  • application/json

Produces

  • application/xml

  • application/json

Parameters

Response

Feature

replaceAllBuildFeatures

Update all build features of the matching build configuration.

Endpoint

/app/rest/buildTypes/{btLocator}/features

Consumes

  • application/xml

  • application/json

Produces

  • application/xml

  • application/json

Parameters

Response

Features

deleteFeatureOfBuildType

Remove a build feature of the matching build configuration.

Endpoint

/app/rest/buildTypes/{btLocator}/features/{featureId}

Parameters

getBuildFeature

Get a build feature of the matching build configuration.

Endpoint

/app/rest/buildTypes/{btLocator}/features/{featureId}

Produces

  • application/xml

  • application/json

Parameters

Response

Feature

replaceBuildFeature

Update a build feature of the matching build configuration.

Endpoint

/app/rest/buildTypes/{btLocator}/features/{featureId}

Consumes

  • application/xml

  • application/json

Produces

  • application/xml

  • application/json

Parameters

Response

Feature

getAllBuildFeatureParameters

Get all parameters of a build feature of the matching build configuration.

Endpoint

/app/rest/buildTypes/{btLocator}/features/{featureId}/parameters

Produces

  • application/xml

  • application/json

Parameters

Response

Properties

replaceBuildFeatureParameters

Update a parameter of a build feature of the matching build configuration.

Endpoint

/app/rest/buildTypes/{btLocator}/features/{featureId}/parameters

Consumes

  • application/xml

  • application/json

Produces

  • application/xml

  • application/json

Parameters

Response

Properties

getBuildFeatureParameter

Get a parameter of a build feature of the matching build configuration.

Endpoint

/app/rest/buildTypes/{btLocator}/features/{featureId}/parameters/{parameterName}

Produces

  • text/plain

Parameters

Response

string

addParameterToBuildFeature

Update build feature parameter for the matching build configuration.

Endpoint

/app/rest/buildTypes/{btLocator}/features/{featureId}/parameters/{parameterName}

Consumes

  • text/plain

Produces

  • text/plain

Parameters

Response

string

getBuildFeatureSetting

Get the setting of a build feature of the matching build configuration.

Endpoint

/app/rest/buildTypes/{btLocator}/features/{featureId}/{name}

Produces

  • text/plain

Parameters

Response

string

setBuildFeatureParameter

Update a parameter of a build feature of the matching build configuration.

Endpoint

/app/rest/buildTypes/{btLocator}/features/{featureId}/{name}

Consumes

  • text/plain

Produces

  • text/plain

Parameters

Response

string

getAllInvestigationsOfBuildType

Get all investigations of the matching build configuration.

Endpoint

/app/rest/buildTypes/{btLocator}/investigations

Produces

  • application/xml

  • application/json

Parameters

Response

Investigations

deleteBuildParametersOfBuildType

Delete all build parameters.

Endpoint

/app/rest/buildTypes/{btLocator}/parameters

Parameters

getBuildParametersOfBuildType

Get build parameters.

Endpoint

/app/rest/buildTypes/{btLocator}/parameters

Produces

  • application/xml

  • application/json

Parameters

Response

Properties

createBuildParameterOfBuildType

Create a build parameter.

Endpoint

/app/rest/buildTypes/{btLocator}/parameters

Consumes

  • application/xml

  • application/json

Produces

  • application/xml

  • application/json

Parameters

Response

Property

updateBuildParametersOfBuildType

Update build parameters.

Endpoint

/app/rest/buildTypes/{btLocator}/parameters

Consumes

  • application/xml

  • application/json

Produces

  • application/xml

  • application/json

Parameters

Response

Properties

deleteBuildParameterOfBuildType

Delete build parameter.

Endpoint

/app/rest/buildTypes/{btLocator}/parameters/{name}

Parameters

getBuildParameterOfBuildType

Get build parameter.

Endpoint

/app/rest/buildTypes/{btLocator}/parameters/{name}

Produces

  • application/xml

  • application/json

Parameters

Response

Property

updateBuildParameterOfBuildType

Update build parameter.

Endpoint

/app/rest/buildTypes/{btLocator}/parameters/{name}

Consumes

  • application/xml

  • application/json

Produces

  • application/xml

  • application/json

Parameters

Response

Property

getBuildParameterTypeOfBuildType

Get type of build parameter.

Endpoint

/app/rest/buildTypes/{btLocator}/parameters/{name}/type

Produces

  • application/xml

  • application/json

Parameters

Response

Type

updateBuildParameterTypeOfBuildType

Update type of build parameter.

Endpoint

/app/rest/buildTypes/{btLocator}/parameters/{name}/type

Consumes

  • application/xml

  • application/json

Produces

  • application/xml

  • application/json

Parameters

Response

Type

getBuildParameterSpecificationOfBuildType

Get build parameter specification.

Endpoint

/app/rest/buildTypes/{btLocator}/parameters/{name}/type/rawValue

Produces

  • text/plain

Parameters

Response

string

updateBuildParameterSpecificationOfBuildType

Update build parameter specification.

Endpoint

/app/rest/buildTypes/{btLocator}/parameters/{name}/type/rawValue

Consumes

  • text/plain

Produces

  • text/plain

Parameters

Response

string

getBuildParameterValueOfBuildType

Get value of build parameter.

Endpoint

/app/rest/buildTypes/{btLocator}/parameters/{name}/value

Produces

  • text/plain

Parameters

Response

string

updateBuildParameterValueOfBuildType

Update value of build parameter.

Endpoint

/app/rest/buildTypes/{btLocator}/parameters/{name}/value

Consumes

  • text/plain

Produces

  • text/plain

Parameters

Response

string

getBuildTypeSettingsFile

Get the settings file of the matching build configuration.

Endpoint

/app/rest/buildTypes/{btLocator}/settingsFile

Produces

  • text/plain

Parameters

Response

string

getAllSnapshotDependencies

Get all snapshot dependencies of the matching build configuration.

Endpoint

/app/rest/buildTypes/{btLocator}/snapshot-dependencies

Produces

  • application/xml

  • application/json

Parameters

Response

SnapshotDependencies

addSnapshotDependencyToBuildType

Add a snapshot dependency to the matching build configuration.

Endpoint

/app/rest/buildTypes/{btLocator}/snapshot-dependencies

Consumes

  • application/xml

  • application/json

Produces

  • application/xml

  • application/json

Parameters

Response

SnapshotDependency

replaceAllSnapshotDependencies

Update all snapshot dependencies of the matching build configuration.

Endpoint

/app/rest/buildTypes/{btLocator}/snapshot-dependencies

Consumes

  • application/xml

  • application/json

Produces

  • application/xml

  • application/json

Parameters

Response

SnapshotDependencies

deleteSnapshotDependency

Delete a snapshot dependency of the matching build configuration.

Endpoint

/app/rest/buildTypes/{btLocator}/snapshot-dependencies/{snapshotDepLocator}

Parameters

getSnapshotDependency

Get a snapshot dependency of the matching build configuration.

Endpoint

/app/rest/buildTypes/{btLocator}/snapshot-dependencies/{snapshotDepLocator}

Produces

  • application/xml

  • application/json

Parameters

Response

SnapshotDependency

replaceSnapshotDependency

Update a snapshot dependency of the matching build configuration.

Endpoint

/app/rest/buildTypes/{btLocator}/snapshot-dependencies/{snapshotDepLocator}

Consumes

  • application/xml

  • application/json

Produces

  • application/xml

  • application/json

Parameters

Response

SnapshotDependency

getAllBuildSteps

Get all build steps of the matching build configuration.

Endpoint

/app/rest/buildTypes/{btLocator}/steps

Produces

  • application/xml

  • application/json

Parameters

Response

Steps

addBuildStepToBuildType

Add a build step to the matching build configuration.

Endpoint

/app/rest/buildTypes/{btLocator}/steps

Consumes

  • application/xml

  • application/json

Produces

  • application/xml

  • application/json

Parameters

Response

Step

replaceAllBuildSteps

Update all build steps of the matching build configuration.

Endpoint

/app/rest/buildTypes/{btLocator}/steps

Consumes

  • application/xml

  • application/json

Produces

  • application/xml

  • application/json

Parameters

Response

Steps

deleteBuildStep

Delete a build step of the matching build configuration.

Endpoint

/app/rest/buildTypes/{btLocator}/steps/{stepId}

Parameters

getBuildStep

Get a build step of the matching build configuration.

Endpoint

/app/rest/buildTypes/{btLocator}/steps/{stepId}

Produces

  • application/xml

  • application/json

Parameters

Response

Step

replaceBuildStep

Replace a build step of the matching build configuration.

Endpoint

/app/rest/buildTypes/{btLocator}/steps/{stepId}

Consumes

  • application/xml

  • application/json

Produces

  • application/xml

  • application/json

Parameters

Response

Step

getAllBuildStepParameters

Get all parameters of a build step of the matching build configuration.

Endpoint

/app/rest/buildTypes/{btLocator}/steps/{stepId}/parameters

Produces

  • application/xml

  • application/json

Parameters

Response

Properties

deleteBuildStepParameters

Update a parameter of a build step of the matching build configuration.

Endpoint

/app/rest/buildTypes/{btLocator}/steps/{stepId}/parameters

Consumes

  • application/xml

  • application/json

Produces

  • application/xml

  • application/json

Parameters

Response

Properties

getBuildStepParameter

Get a parameter of a build step of the matching build configuration.

Endpoint

/app/rest/buildTypes/{btLocator}/steps/{stepId}/parameters/{parameterName}

Produces

  • text/plain

Parameters

Response

string

addParameterToBuildStep

Add a parameter to a build step of the matching build configuration.

Endpoint

/app/rest/buildTypes/{btLocator}/steps/{stepId}/parameters/{parameterName}

Consumes

  • text/plain

Produces

  • text/plain

Parameters

Response

string

getBuildStepSetting

Get the setting of a build step of the matching build configuration.

Endpoint

/app/rest/buildTypes/{btLocator}/steps/{stepId}/{fieldName}

Produces

  • text/plain

Parameters

Response

string

setBuildStepParameter

Update a parameter of a build step of the matching build configuration.

Endpoint

/app/rest/buildTypes/{btLocator}/steps/{stepId}/{fieldName}

Consumes

  • text/plain

Produces

  • text/plain

Parameters

Response

string

removeAllTemplates

Detach all templates from the matching build configuration.

Endpoint

/app/rest/buildTypes/{btLocator}/templates

Parameters

getAllBuildTemplates

Get all build templates of the matching build configuration.

Endpoint

/app/rest/buildTypes/{btLocator}/templates

Produces

  • application/xml

  • application/json

Parameters

Response

BuildTypes

addBuildTemplate

Add a build template to the matching build configuration.

Endpoint

/app/rest/buildTypes/{btLocator}/templates

Consumes

  • application/xml

  • application/json

Produces

  • application/xml

  • application/json

Parameters

Response

BuildType

setBuildTypeTemplates

Update all templates of the matching build configuration.

Endpoint

/app/rest/buildTypes/{btLocator}/templates

Consumes

  • application/xml

  • application/json

Produces

  • application/xml

  • application/json

Parameters

Response

BuildTypes

removeTemplate

Detach a template from the matching build configuration.

Endpoint

/app/rest/buildTypes/{btLocator}/templates/{templateLocator}

Parameters

getBuildTemplate

Get a template of the matching build configuration.

Endpoint

/app/rest/buildTypes/{btLocator}/templates/{templateLocator}

Produces

  • application/xml

  • application/json

Parameters

Response

BuildType

getAllTriggers

Get all triggers of the matching build configuration.

Endpoint

/app/rest/buildTypes/{btLocator}/triggers

Produces

  • application/xml

  • application/json

Parameters

Response

Triggers

addTriggerToBuildType

Add a trigger to the matching build configuration.

Endpoint

/app/rest/buildTypes/{btLocator}/triggers

Consumes

  • application/xml

  • application/json

Produces

  • application/xml

  • application/json

Parameters

Response

Trigger

replaceAllTriggers

Update all triggers of the matching build configuration.

Endpoint

/app/rest/buildTypes/{btLocator}/triggers

Consumes

  • application/xml

  • application/json

Produces

  • application/xml

  • application/json

Parameters

Response

Triggers

deleteTrigger

Delete a trigger of the matching build configuration.

Endpoint

/app/rest/buildTypes/{btLocator}/triggers/{triggerLocator}

Parameters

getTrigger

Get a trigger of the matching build configuration.

Endpoint

/app/rest/buildTypes/{btLocator}/triggers/{triggerLocator}

Produces

  • application/xml

  • application/json

Parameters

Response

Trigger

replaceTrigger

Update a trigger of the matching build configuration.

Endpoint

/app/rest/buildTypes/{btLocator}/triggers/{triggerLocator}

Consumes

  • application/xml

  • application/json

Produces

  • application/xml

  • application/json

Parameters

Response

Trigger

getTriggerParameter

Get a parameter of a trigger of the matching build configuration.

Endpoint

/app/rest/buildTypes/{btLocator}/triggers/{triggerLocator}/{fieldName}

Produces

  • text/plain

Parameters

Response

string

setTriggerParameter

Update a parameter of a trigger of the matching build configuration.

Endpoint

/app/rest/buildTypes/{btLocator}/triggers/{triggerLocator}/{fieldName}

Consumes

  • text/plain

Produces

  • text/plain

Parameters

Response

string

getAllVcsRootsOfBuildType

Get all VCS roots of the matching build configuration.

Endpoint

/app/rest/buildTypes/{btLocator}/vcs-root-entries

Produces

  • application/xml

  • application/json

Parameters

Response

VcsRootEntries

addVcsRootToBuildType

Add a VCS root to the matching build.

Endpoint

/app/rest/buildTypes/{btLocator}/vcs-root-entries

Consumes

  • application/xml

  • application/json

Produces

  • application/xml

  • application/json

Parameters

Response

VcsRootEntry

replaceAllVcsRoots

Update all VCS roots of the matching build configuration.

Endpoint

/app/rest/buildTypes/{btLocator}/vcs-root-entries

Consumes

  • application/xml

  • application/json

Produces

  • application/xml

  • application/json

Parameters

Response

VcsRootEntries

deleteVcsRootOfBuildType

Remove a VCS root of the matching build configuration.

Endpoint

/app/rest/buildTypes/{btLocator}/vcs-root-entries/{vcsRootLocator}

Parameters

getVcsRoot

Get a VCS root of the matching build configuration.

Endpoint

/app/rest/buildTypes/{btLocator}/vcs-root-entries/{vcsRootLocator}

Produces

  • application/xml

  • application/json

Parameters

Response

VcsRootEntry

updateBuildTypeVcsRoot

Update a VCS root of the matching build configuration.

Endpoint

/app/rest/buildTypes/{btLocator}/vcs-root-entries/{vcsRootLocator}

Consumes

  • application/xml

  • application/json

Produces

  • application/xml

  • application/json

Parameters

Response

VcsRootEntry

getVcsRootCheckoutRules

Get checkout rules of a VCS root of the matching build configuration.

Endpoint

/app/rest/buildTypes/{btLocator}/vcs-root-entries/{vcsRootLocator}/checkout-rules

Produces

  • text/plain

Parameters

Response

string

updateBuildTypeVcsRootCheckoutRules

Update checkout rules of a VCS root of the matching build configuration.

Endpoint

/app/rest/buildTypes/{btLocator}/vcs-root-entries/{vcsRootLocator}/checkout-rules

Consumes

  • text/plain

Produces

  • text/plain

Parameters

Response

string

getFilesListOfBuildType

List all files.

Endpoint

/app/rest/buildTypes/{btLocator}/vcs/files/latest

Produces

  • application/xml

  • application/json

Parameters

  • btLocator: string<BuildTypeLocator>

  • basePath: string

  • locator: string

  • fields: string

  • resolveParameters: boolean

Response

Files

getZippedFileOfBuildType

Get specific file zipped.

Endpoint

/app/rest/buildTypes/{btLocator}/vcs/files/latest/archived{path}

Produces

  • */*

Parameters

  • path: string

  • btLocator: string<BuildTypeLocator>

  • basePath: string

  • locator: string

  • name: string

  • resolveParameters: boolean

downloadFileOfBuildType

Download specific file.

Endpoint

/app/rest/buildTypes/{btLocator}/vcs/files/latest/files{path}

Produces

  • */*

Parameters

getFileMetadataOfBuildType

Get metadata of specific file.

Endpoint

/app/rest/buildTypes/{btLocator}/vcs/files/latest/metadata{path}

Produces

  • application/xml

  • application/json

Parameters

Response

file

getFilesListForSubpathOfBuildType

List files under this path.

Endpoint

/app/rest/buildTypes/{btLocator}/vcs/files/latest/{path}

Produces

  • application/xml

  • application/json

Parameters

  • path: string

  • btLocator: string<BuildTypeLocator>

  • basePath: string

  • locator: string

  • fields: string

  • resolveParameters: boolean

Response

Files

getVcsRootInstancesOfBuildType

Get all VCS root instances of the matching build configuration.

Endpoint

/app/rest/buildTypes/{btLocator}/vcsRootInstances

Produces

  • application/xml

  • application/json

Parameters

Response

VcsRootInstances

getBuildTypeField

Get a field of the matching build configuration.

Endpoint

/app/rest/buildTypes/{btLocator}/{field}

Produces

  • text/plain

Parameters

Response

string

setBuildTypeField

Update a field of the matching build configuration.

Endpoint

/app/rest/buildTypes/{btLocator}/{field}

Consumes

  • text/plain

Produces

  • text/plain

Parameters

Response

string

Last modified: 30 March 2022