You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Build Configuration/Template details: GET http://teamcity:8111/app/rest/buildTypes/ (details on the Build Configuration locator).
Please note that there is no transaction, etc. support for settings editing in TeamCity, so all the settings modified via REST API are taken into account at once. This can result in half-configured builds triggered, etc. Please make sure you pause a build configuration before changing its settings if this aspect is important for your case.
To get aggregated status for several build configurations, s ee Build Status Icon section.
Build configuration parameters: GET/DELETE/PUT http://teamcity:8111/app/rest/buildTypes/ /parameters/<parameter_name> (produces XML, JSON and plain text depending on the "Accept" header, accepts plain text and XML and JSON). The requests .../parameters/<parameter_name>/name and .../parameters/<parameter_name>/value are also supported.
Attach VCS root to a build configuration: POST http://teamcity:8111/app/rest/buildTypes//vcs-root-entries . The XML/JSON posted is the same as retrieved by GET request to http://teamcity:8111/app/rest/buildTypes//vcs-root-entries/ except for the secure settings like password: these are not included into responses and should be supplied before POSTing back.
Create a new build configuration with all settings: POST http://teamcity:8111/app/rest/buildTypes . The XML/JSON posted is the same as retrieved by GET request. (Note that /app/rest/project/XXX/buildTypes still uses the previous version notation and accepts another entity.)
Read, detach and attach a build configuration from/to a template: GET/DELETE/PUT http://teamcity:8111/app/rest/buildTypes//template (PUT accepts template locator with "text/plain" Content-Type)
The text was updated successfully, but these errors were encountered:
Build Configuration/Template details: GET http://teamcity:8111/app/rest/buildTypes/ (details on the Build Configuration locator).
Please note that there is no transaction, etc. support for settings editing in TeamCity, so all the settings modified via REST API are taken into account at once. This can result in half-configured builds triggered, etc. Please make sure you pause a build configuration before changing its settings if this aspect is important for your case.
To get aggregated status for several build configurations, s ee Build Status Icon section.
Get/set paused build configuration state: GET/PUT http://teamcity:8111/app/rest/buildTypes/ /paused (put "true" or "false" text as text/plain)
Build configuration settings: GET/DELETE/PUT http://teamcity:8111/app/rest/buildTypes/ /settings/<setting_name>
Build configuration parameters: GET/DELETE/PUT
http://teamcity:8111/app/rest/buildTypes/ /parameters/<parameter_name> (produces XML, JSON and plain text depending on the "Accept" header, accepts plain text and XML and JSON). The requests .../parameters/<parameter_name>/name and .../parameters/<parameter_name>/value are also supported.
Build configuration steps: GET/DELETE http://teamcity:8111/app/rest/buildTypes/ /steps/<step_id>
Create build configuration step: POST http://teamcity:8111/app/rest/buildTypes//steps. The XML/JSON posted is the same as retrieved by GET request to .../steps/<step_id> except for the secure settings like password: these are not included into responses and should be supplied before POSTing back
Features, triggers, agent requirements, artifact and snapshot dependencies follow the same pattern as steps with URLs like:
http://teamcity:8111/app/rest/buildTypes//features/
http://teamcity:8111/app/rest/buildTypes//triggers/
http://teamcity:8111/app/rest/buildTypes//agent-requirements/
http://teamcity:8111/app/rest/buildTypes//artifact-dependencies/
http://teamcity:8111/app/rest/buildTypes//snapshot-dependencies/
Since TeamCity 10, it is possible to disable/enable artifact dependencies and agent requirements:
Disable/enable an artifact dependency PUT http://teamcity:8111/app/rest/buildTypes//artifact-dependencies//disabled (put " true " or "false" text as text/plain)
Disable/enable an agent requirement PUT http://teamcity:8111/app/rest/buildTypes//agent-requirements//disabled (put " true " or "false" text as text/plain)
Build configuration VCS roots: GET/DELETE http://teamcity:8111/app/rest/buildTypes//vcs-root-entries/
Attach VCS root to a build configuration: POST http://teamcity:8111/app/rest/buildTypes//vcs-root-entries . The XML/JSON posted is the same as retrieved by GET request to http://teamcity:8111/app/rest/buildTypes//vcs-root-entries/ except for the secure settings like password: these are not included into responses and should be supplied before POSTing back.
Create a new build configuration with all settings: POST http://teamcity:8111/app/rest/buildTypes . The XML/JSON posted is the same as retrieved by GET request. (Note that /app/rest/project/XXX/buildTypes still uses the previous version notation and accepts another entity.)
Create a new empty build configuration: POST plain text (name) to http://teamcity:8111/app/rest/projects//buildTypes
Copy a build configuration: POST XML to http://teamcity:8111/app/rest/projects//buildTypes
Read, detach and attach a build configuration from/to a template: GET/DELETE/PUT http://teamcity:8111/app/rest/buildTypes//template (PUT accepts template locator with "text/plain" Content-Type)
The text was updated successfully, but these errors were encountered: