TeamCity REST API

Get all known agents.Get agent matching the locator.Delete an inactive agent.Get the authorization info of the matching agent.Update the authorization info of the matching agent.Get the build configuration run policy of the matching agent.Update build configuration run policy of agent matching locator.Get build types compatible with the matching agent.Check if the matching agent is enabled.Update the enablement status of the matching agent.Get build types incompatible with the matching agent.Get the agent pool of the matching agent.Assign the matching agent to the specified agent pool.Get a field of the matching agent.Update a field of the matching agent.

Get all agent pools.Create a new agent pool.Get the agent pool matching the locator.Delete the agent pool matching the locator.Get the agent of the matching agent pool.Assign the agent to the matching agent pool.Get all projects of the matching agent pool.Assign the project to the matching agent pool.Update projects of the matching agent pool.Unassign all projects from the matching agent pool.Unassign the project from the matching agent pool.Get a field of the matching agent pool.Update a field of the matching agent pool.

Get all audit events.Get audit event matching the locator.

Update a users avatar Delete a users avatar Get a users avatar Get a users avatar

Get all builds.Get the build status of aggregated matching builds.Get the status icon (in specified format) of aggregated matching builds.Get multiple builds matching the locator.cancelMultipleBuilds Delete multiple builds matching the locator.Update comments in multiple matching builds.Delete comments of multiple matching builds.Pin multiple matching builds.Add tags to multiple matching builds.Remove tags from multiple matching builds.Get build matching the locator.cancelBuild Delete build matching the locator.Get artifact dependency changes of the matching build.List all files.Get specific file zipped.Download specific file.Get metadata of specific file.List files under this path.Get the artifacts' directory of the matching build.Remove build parameters from the matching build.Check if the matching build is canceled.Update the comment on the matching build.Remove the build comment matching the locator.Marks the running build as finished by passing agent the current time of the build to finish.Get the finish date of the matching build.Marks the running build as finished by passing agent the current time of the build to finish.Adds a message to the build log. Service messages are accepted.Get the number of the matching build.Update the number of the matching build.Check if the matching build is pinned.Update the pin info of the matching build.Get build problems of the matching build.Add a build problem to the matching build.Get related issues of the matching build.Get the resolvement status of the matching build.Get actual build parameters of the matching build.Update a build parameter of the matching build.Starts the queued build as an agent-less build and returns the corresponding running build.Get a source file of the matching build.Get all statistical values of the matching build.Get a statistical value of the matching build.Get the status icon (in specified format) of the matching build.Get the build status text of the matching build.Update the build status of the matching build.Get tags of the matching build.Add tags to the matching build.Update tags of the matching build.Get test occurrences of the matching build.Get VCS labels of the matching build.Add a VCS label to the matching build.Get a field of the matching build.

Get all queued builds.Add a new build to the queue.Delete all queued builds.Update the build queue order.Get the queue position of a queued matching build.Update the queue position of a queued matching build.Get tags of the queued matching build.Add tags to the matching build.Get a queued matching build.Cancel a queued matching build.Delete a queued matching build.Get compatible agents for a queued matching build.

Get all build configurations.Create a new build configuration.Get build configuration matching the locator.Delete build configuration matching the locator.Get all agent requirements of the matching build configuration.Add an agent requirement to the matching build configuration.Update all agent requirements of the matching build configuration.Get an agent requirement of the matching build configuration.Update an agent requirement of the matching build configuration.Remove an agent requirement of the matching build configuration.Get a setting of an agent requirement of the matching build configuration.Update a parameter of an agent requirement of the matching build configuration.Get external IDs of the matching build configuration.Get all artifact dependencies of the matching build configuration.Add an artifact dependency to the matching build configuration.Update all artifact dependencies of the matching build configuration.Get an artifact dependency of the matching build configuration.Update an artifact dependency of the matching build configuration.Remove an artifact dependency from the matching build configuration.Get a parameter of an artifact dependency of the matching build configuration.Update a parameter of an artifact dependency of the matching build configuration.Get all branches of the matching build configuration.Get tags of builds of the matching build configuration.Get builds of the matching build configuration.Get all build features of the matching build configuration.Add build feature to the matching build configuration.Update all build features of the matching build configuration.Get a build feature of the matching build configuration.Update a build feature of the matching build configuration.Remove a build feature of the matching build configuration.Get all parameters of a build feature of the matching build configuration.Update a parameter of a build feature of the matching build configuration.Get a parameter of a build feature of the matching build configuration.Update build feature parameter for the matching build configuration.Get the setting of a build feature of the matching build configuration.Update a parameter of a build feature of the matching build configuration.Get all investigations of the matching build configuration.Get build parameters.Create a build parameter.Update build parameters.Delete all build parameters.Get build parameter.Update build parameter.Delete build parameter.Get type of build parameter.Update type of build parameter.Get build parameter specification.Update build parameter specification.Get value of build parameter.Update value of build parameter.Get the settings file of the matching build configuration.Get all snapshot dependencies of the matching build configuration.Add a snapshot dependency to the matching build configuration.Update all snapshot dependencies of the matching build configuration.Get a snapshot dependency of the matching build configuration.Update a snapshot dependency of the matching build configuration.Delete a snapshot dependency of the matching build configuration.Get all build steps of the matching build configuration.Add a build step to the matching build configuration.Update all build steps of the matching build configuration.Get a build step of the matching build configuration.Replace a build step of the matching build configuration.Delete a build step of the matching build configuration.Get all parameters of a build step of the matching build configuration.Update a parameter of a build step of the matching build configuration.Get a parameter of a build step of the matching build configuration.Add a parameter to a build step of the matching build configuration.Get the setting of a build step of the matching build configuration.Update a parameter of a build step of the matching build configuration.Get all build templates of the matching build configuration.Add a build template to the matching build configuration.Update all templates of the matching build configuration.Detach all templates from the matching build configuration.Get a template of the matching build configuration.Detach a template from the matching build configuration.Get all triggers of the matching build configuration.Add a trigger to the matching build configuration.Update all triggers of the matching build configuration.Get a trigger of the matching build configuration.Update a trigger of the matching build configuration.Delete a trigger of the matching build configuration.Get a parameter of a trigger of the matching build configuration.Update a parameter of a trigger of the matching build configuration.Get all VCS roots of the matching build configuration.Add a VCS root to the matching build.Update all VCS roots of the matching build configuration.Get a VCS root of the matching build configuration.Update a VCS root of the matching build configuration.Remove a VCS root of the matching build configuration.Get checkout rules of a VCS root of the matching build configuration.Update checkout rules of a VCS root of the matching build configuration.List all files.Get specific file zipped.Download specific file.Get metadata of specific file.List files under this path.Get all VCS root instances of the matching build configuration.Get a field of the matching build configuration.Update a field of the matching build configuration.

Get all changes.Get change matching the locator.Get attributes of the matching change.Get duplicates of the matching change.Get issues of the matching change.Get parent changes of the matching change.Get parent revisions of the matching change.Get a VCS root instance of the matching change.Get a field of the matching change.

Get all cloud images.Get cloud image matching the locator.Get all cloud instances.Start a new cloud instance.Get cloud instance matching the locator.Stop cloud instance matching the locator.Get all cloud profiles.Get cloud profile matching the locator.

Get all user groups.Add a new user group.Get user group matching the locator.Delete user group matching the locator.Get parent groups of the matching user group.Update parent groups of the matching user group.Get properties of the matching user group.Get a property of the matching user group.Update a property of the matching user group.Remove a property of the matching user group.Get all roles of the matching user group.Add a role to the matching user group.Update roles of the matching user group.Get a role with the specific scope of the matching user group.Add a role with the specific scope to the matching user group.Remove a role with the specific scope from the matching user group.

Get all investigations.Create a new investigation.Create multiple new investigations.Get investigation matching the locator.Update investigation matching the locator.Delete investigation matching the locator.

Get all muted tests.Mute a test.Mute multiple tests.Get a muted test.Unmute the matching test.

Get all build problems.Get a matching build problem.

ProblemOccurrence

Get all build problem occurrences.Get a matching build problem occurrence.

Get all projects.Create a new project.Get project matching the locator.Delete project matching the locator.Get agent pools appointed to the matching project.Assign the matching project to the agent pool.Update agent pools apppointed to the matching project.Unassign a project from the matching agent pool.Get all branches of the matching project.Add a build configuration to the matching project.Get the default template of the matching project.Update the default template of the matching project.Remove the default template from the matching project.Update all build configurations order of the matching project.Get all subprojects ordered of the matching project.Update all subprojects order of the matching project.Get build parameters.Create a build parameter.Update build parameters.Delete all build parameters.Get build parameter.Update build parameter.Delete build parameter.Get type of build parameter.Update type of build parameter.Get build parameter specification.Update build parameter specification.Get value of build parameter.Update value of build parameter.Get the parent project of the matching project.Update the parent project of the matching project.Get all features.Add a feature.Update all features.Get a matching feature.Update a matching feature.Delete a matching feature.Create a new secure token for the matching project.Get a secure token of the matching project.Get the settings file of the matching build configuration.Get all templates of the matching project.Add a build configuration template to the matching project.Get a field of the matching project.Update a field of the matching project.

Get root endpoints.Get the API version.Get the plugin info.Get the TeamCity server version.

Get the server info.Get the latest backup status.Start a new backup.List all files.Get specific file zipped.Download specific file.Get metadata of specific file.List files under this path.Get the licensing data.Get all license keys.Add license keys.Get a license key.Delete a license key.Get metrics.Get all plugins.Get a field of the server info.

Get all tests.Get a matching test.

Get all test occurrences.Get a matching test occurrence.

Get all users.Create a new user.Get user matching the locator.Update user matching the locator.Delete user matching the locator.Remove the RememberMe data of the matching user.Get all groups of the matching user.Update groups of the matching user.Get a user group of the matching user.Remove the matching user from the specific group.Get all permissions effective for the matching user.Get all properties of the matching user.Get a property of the matching user.Update a property of the matching user.Remove a property of the matching user.Get all user roles of the matching user.Add a role to the matching user.Update user roles of the matching user.Get a user role with the specific scope from the matching user.Add a role with the specific scope to the matching user.Remove a role with the specific scope from the matching user.Get all authentication tokens of the matching user.Create a new authentication token for the matching user.Remove an authentication token from the matching user.Get a field of the matching user.Update a field of the matching user.Remove a property of the matching user.

Get all VCS roots.Add a new VCS root.Get root endpoints.Remove VCS root matching the locator.Get all VCS root instances of the matching VCS root.Get all properties of the matching VCS root.Update all properties of the matching VCS root.Delete all properties of the matching VCS root.Get a property on the matching VCS root.Update a property of the matching VCS root.Delete a property of the matching VCS root.Get the settings file of the matching VCS root.Get a field of the matching VCS root.Update a field of the matching VCS root.

VcsRootInstance

Get all VCS root instances.Check for the pending changes for all VCS root instances.Send the commit hook notification.Get VCS root instance matching the locator.List all files.Get specific file zipped.Download specific file.Get metadata of specific file.List files under this path.Get all properties of the matching VCS root instance.Get the repository state of the matching VCS root instance.Update the repository state of the matching VCS root instance.Delete the last repository state of the matching VCS root instance.Get the creation date of the matching VCS root instance.Get a field of the matching VCS root instance.Get a field of the matching VCS root instance.Remove a field of the matching VCS root instance.

TeamCity REST API

Get all known agents.Get agent matching the locator.Delete an inactive agent.Get the authorization info of the matching agent.Update the authorization info of the matching agent.Get the build configuration run policy of the matching agent.Update build configuration run policy of agent matching locator.Get build types compatible with the matching agent.Check if the matching agent is enabled.Update the enablement status of the matching agent.Get build types incompatible with the matching agent.Get the agent pool of the matching agent.Assign the matching agent to the specified agent pool.Get a field of the matching agent.Update a field of the matching agent.

Get all agent pools.Create a new agent pool.Get the agent pool matching the locator.Delete the agent pool matching the locator.Get the agent of the matching agent pool.Assign the agent to the matching agent pool.Get all projects of the matching agent pool.Assign the project to the matching agent pool.Update projects of the matching agent pool.Unassign all projects from the matching agent pool.Unassign the project from the matching agent pool.Get a field of the matching agent pool.Update a field of the matching agent pool.

Get all audit events.Get audit event matching the locator.

Update a users avatar Delete a users avatar Get a users avatar Get a users avatar

Get all builds.Get the build status of aggregated matching builds.Get the status icon (in specified format) of aggregated matching builds.Get multiple builds matching the locator.cancelMultipleBuilds Delete multiple builds matching the locator.Update comments in multiple matching builds.Delete comments of multiple matching builds.Pin multiple matching builds.Add tags to multiple matching builds.Remove tags from multiple matching builds.Get build matching the locator.cancelBuild Delete build matching the locator.Get artifact dependency changes of the matching build.List all files.Get specific file zipped.Download specific file.Get metadata of specific file.List files under this path.Get the artifacts' directory of the matching build.Remove build parameters from the matching build.Check if the matching build is canceled.Update the comment on the matching build.Remove the build comment matching the locator.Marks the running build as finished by passing agent the current time of the build to finish.Get the finish date of the matching build.Marks the running build as finished by passing agent the current time of the build to finish.Adds a message to the build log. Service messages are accepted.Get the number of the matching build.Update the number of the matching build.Check if the matching build is pinned.Update the pin info of the matching build.Get build problems of the matching build.Add a build problem to the matching build.Get related issues of the matching build.Get the resolvement status of the matching build.Get actual build parameters of the matching build.Update a build parameter of the matching build.Starts the queued build as an agent-less build and returns the corresponding running build.Get a source file of the matching build.Get all statistical values of the matching build.Get a statistical value of the matching build.Get the status icon (in specified format) of the matching build.Get the build status text of the matching build.Update the build status of the matching build.Get tags of the matching build.Add tags to the matching build.Update tags of the matching build.Get test occurrences of the matching build.Get VCS labels of the matching build.Add a VCS label to the matching build.Get a field of the matching build.

Get all queued builds.Add a new build to the queue.Delete all queued builds.Update the build queue order.Get the queue position of a queued matching build.Update the queue position of a queued matching build.Get tags of the queued matching build.Add tags to the matching build.Get a queued matching build.Cancel a queued matching build.Delete a queued matching build.Get compatible agents for a queued matching build.

Get all build configurations.Create a new build configuration.Get build configuration matching the locator.Delete build configuration matching the locator.Get all agent requirements of the matching build configuration.Add an agent requirement to the matching build configuration.Update all agent requirements of the matching build configuration.Get an agent requirement of the matching build configuration.Update an agent requirement of the matching build configuration.Remove an agent requirement of the matching build configuration.Get a setting of an agent requirement of the matching build configuration.Update a parameter of an agent requirement of the matching build configuration.Get external IDs of the matching build configuration.Get all artifact dependencies of the matching build configuration.Add an artifact dependency to the matching build configuration.Update all artifact dependencies of the matching build configuration.Get an artifact dependency of the matching build configuration.Update an artifact dependency of the matching build configuration.Remove an artifact dependency from the matching build configuration.Get a parameter of an artifact dependency of the matching build configuration.Update a parameter of an artifact dependency of the matching build configuration.Get all branches of the matching build configuration.Get tags of builds of the matching build configuration.Get builds of the matching build configuration.Get all build features of the matching build configuration.Add build feature to the matching build configuration.Update all build features of the matching build configuration.Get a build feature of the matching build configuration.Update a build feature of the matching build configuration.Remove a build feature of the matching build configuration.Get all parameters of a build feature of the matching build configuration.Update a parameter of a build feature of the matching build configuration.Get a parameter of a build feature of the matching build configuration.Update build feature parameter for the matching build configuration.Get the setting of a build feature of the matching build configuration.Update a parameter of a build feature of the matching build configuration.Get all investigations of the matching build configuration.Get build parameters.Create a build parameter.Update build parameters.Delete all build parameters.Get build parameter.Update build parameter.Delete build parameter.Get type of build parameter.Update type of build parameter.Get build parameter specification.Update build parameter specification.Get value of build parameter.Update value of build parameter.Get the settings file of the matching build configuration.Get all snapshot dependencies of the matching build configuration.Add a snapshot dependency to the matching build configuration.Update all snapshot dependencies of the matching build configuration.Get a snapshot dependency of the matching build configuration.Update a snapshot dependency of the matching build configuration.Delete a snapshot dependency of the matching build configuration.Get all build steps of the matching build configuration.Add a build step to the matching build configuration.Update all build steps of the matching build configuration.Get a build step of the matching build configuration.Replace a build step of the matching build configuration.Delete a build step of the matching build configuration.Get all parameters of a build step of the matching build configuration.Update a parameter of a build step of the matching build configuration.Get a parameter of a build step of the matching build configuration.Add a parameter to a build step of the matching build configuration.Get the setting of a build step of the matching build configuration.Update a parameter of a build step of the matching build configuration.Get all build templates of the matching build configuration.Add a build template to the matching build configuration.Update all templates of the matching build configuration.Detach all templates from the matching build configuration.Get a template of the matching build configuration.Detach a template from the matching build configuration.Get all triggers of the matching build configuration.Add a trigger to the matching build configuration.Update all triggers of the matching build configuration.Get a trigger of the matching build configuration.Update a trigger of the matching build configuration.Delete a trigger of the matching build configuration.Get a parameter of a trigger of the matching build configuration.Update a parameter of a trigger of the matching build configuration.Get all VCS roots of the matching build configuration.Add a VCS root to the matching build.Update all VCS roots of the matching build configuration.Get a VCS root of the matching build configuration.Update a VCS root of the matching build configuration.Remove a VCS root of the matching build configuration.Get checkout rules of a VCS root of the matching build configuration.Update checkout rules of a VCS root of the matching build configuration.List all files.Get specific file zipped.Download specific file.Get metadata of specific file.List files under this path.Get all VCS root instances of the matching build configuration.Get a field of the matching build configuration.Update a field of the matching build configuration.

Get all changes.Get change matching the locator.Get attributes of the matching change.Get duplicates of the matching change.Get issues of the matching change.Get parent changes of the matching change.Get parent revisions of the matching change.Get a VCS root instance of the matching change.Get a field of the matching change.

Get all cloud images.Get cloud image matching the locator.Get all cloud instances.Start a new cloud instance.Get cloud instance matching the locator.Stop cloud instance matching the locator.Get all cloud profiles.Get cloud profile matching the locator.

Get all user groups.Add a new user group.Get user group matching the locator.Delete user group matching the locator.Get parent groups of the matching user group.Update parent groups of the matching user group.Get properties of the matching user group.Get a property of the matching user group.Update a property of the matching user group.Remove a property of the matching user group.Get all roles of the matching user group.Add a role to the matching user group.Update roles of the matching user group.Get a role with the specific scope of the matching user group.Add a role with the specific scope to the matching user group.Remove a role with the specific scope from the matching user group.

Get all investigations.Create a new investigation.Create multiple new investigations.Get investigation matching the locator.Update investigation matching the locator.Delete investigation matching the locator.

Get all muted tests.Mute a test.Mute multiple tests.Get a muted test.Unmute the matching test.

Get all build problems.Get a matching build problem.

ProblemOccurrence

Get all build problem occurrences.Get a matching build problem occurrence.

Get all projects.Create a new project.Get project matching the locator.Delete project matching the locator.Get agent pools appointed to the matching project.Assign the matching project to the agent pool.Update agent pools apppointed to the matching project.Unassign a project from the matching agent pool.Get all branches of the matching project.Add a build configuration to the matching project.Get the default template of the matching project.Update the default template of the matching project.Remove the default template from the matching project.Update all build configurations order of the matching project.Get all subprojects ordered of the matching project.Update all subprojects order of the matching project.Get build parameters.Create a build parameter.Update build parameters.Delete all build parameters.Get build parameter.Update build parameter.Delete build parameter.Get type of build parameter.Update type of build parameter.Get build parameter specification.Update build parameter specification.Get value of build parameter.Update value of build parameter.Get the parent project of the matching project.Update the parent project of the matching project.Get all features.Add a feature.Update all features.Get a matching feature.Update a matching feature.Delete a matching feature.Create a new secure token for the matching project.Get a secure token of the matching project.Get the settings file of the matching build configuration.Get all templates of the matching project.Add a build configuration template to the matching project.Get a field of the matching project.Update a field of the matching project.

Get root endpoints.Get the API version.Get the plugin info.Get the TeamCity server version.

Get the server info.Get the latest backup status.Start a new backup.List all files.Get specific file zipped.Download specific file.Get metadata of specific file.List files under this path.Get the licensing data.Get all license keys.Add license keys.Get a license key.Delete a license key.Get metrics.Get all plugins.Get a field of the server info.

Get all tests.Get a matching test.

Get all test occurrences.Get a matching test occurrence.

Get all users.Create a new user.Get user matching the locator.Update user matching the locator.Delete user matching the locator.Remove the RememberMe data of the matching user.Get all groups of the matching user.Update groups of the matching user.Get a user group of the matching user.Remove the matching user from the specific group.Get all permissions effective for the matching user.Get all properties of the matching user.Get a property of the matching user.Update a property of the matching user.Remove a property of the matching user.Get all user roles of the matching user.Add a role to the matching user.Update user roles of the matching user.Get a user role with the specific scope from the matching user.Add a role with the specific scope to the matching user.Remove a role with the specific scope from the matching user.Get all authentication tokens of the matching user.Create a new authentication token for the matching user.Remove an authentication token from the matching user.Get a field of the matching user.Update a field of the matching user.Remove a property of the matching user.

Get all VCS roots.Add a new VCS root.Get root endpoints.Remove VCS root matching the locator.Get all VCS root instances of the matching VCS root.Get all properties of the matching VCS root.Update all properties of the matching VCS root.Delete all properties of the matching VCS root.Get a property on the matching VCS root.Update a property of the matching VCS root.Delete a property of the matching VCS root.Get the settings file of the matching VCS root.Get a field of the matching VCS root.Update a field of the matching VCS root.

VcsRootInstance

Get all VCS root instances.Check for the pending changes for all VCS root instances.Send the commit hook notification.Get VCS root instance matching the locator.List all files.Get specific file zipped.Download specific file.Get metadata of specific file.List files under this path.Get all properties of the matching VCS root instance.Get the repository state of the matching VCS root instance.Update the repository state of the matching VCS root instance.Delete the last repository state of the matching VCS root instance.Get the creation date of the matching VCS root instance.Get a field of the matching VCS root instance.Get a field of the matching VCS root instance.Remove a field of the matching VCS root instance.

Home TeamCity REST API BuildTypeGet the settings file of the matching build configuration.

Get the settings file of the matching build configuration.

GET {{baseUrl}}/app/rest/buildTypes/:btLocator/settingsFile

RESPONSES

status: OK

&quot;\u003cstring\u003e&quot;

Update value of build parameter.

Get all snapshot dependencies of the matching build configuration.