We have about 190 projects and 800 build configurations. Similarly to James' description, developers would like our team to wrap up our company-specific conventions for TeamCity (and related resources) and put it in their hands (we'll probably also do it in Rails). Our deployment system for instance has quite a complete remoting API, but TeamCity is lacking one. A well-designed and highly functional REST api would be a tremendous help.

A request in the forums: http://devnet.jetbrains.net/message/5269374#5269374

This would also be useful to our organisation. The solution above (directly editing XML config) is not usable as we run a shared instance of the server and could not guarantee that users were not changing config at the same time. It would be great if you could implement an admin API.

Anthony, what do you mean by "shared instance"?

We have several teams building projects on that server and each administers their own project(s). Because of timezones and late working it would be awkward to 'close the server' while a script edited the config - not to mention the fact that changes would need to be batched, which would partially defeat the point of an automated system.

Ok I can see what you mean, I thought you were using multiple instances of the server pointing to the same configuration, which left me surprised.

Anthony,

Can you detail why do you need to do automated changes to the configurations (probably with use cases)?
Can you list the operations that you need most to do remotely?

There is only one use case really. When a new project starts up we want to be able to create all the infrastructure in one go, so the subversion repository, the CI project the Issue tracking project, etc. Hence we want an interface that talks to all the different apps and creates the relevant config. So we would like the ability to create a new project (bare minimum), and ideally the ability to create build configurations. Creating and permissioning users would also be a nice-to have - but not so important.

Anthony,

Thank you for details. It seems that for now you can try to create a project with default settings that you would copy to create a new one.

Creating a new project by copying an existing project (or using a template) would be fine. Are you saying that we could do this without an API, or are you confirming that this functionality would be enough if there was an API?

Anthony,

Most probably you can copy the project now from an external script using "undocumented" way like the one described on the page. The actual URL and parameters can be looked up from the actual request browser sends to the server when you copy a project in UI.
However, since this is an undocumented way, it can be changed in any of the future TeamCity versions without any prior notice.

Thanks, we will look at this. However a proper API would be better :-)

Also requested in forum thread http://devnet.jetbrains.net/message/5284371

Request in forum to modify build trigger settings: http://devnet.jetbrains.net/message/5286034

Any updates here? Having a web service API to create projects and builds would do wonders for our organization

request to change VCS roots http://devnet.jetbrains.net/thread/292893

For us it would be helpful if SBuildType options (like BT_MAX_RUNNING_BUILDS) could be set via REST. This way we could e.g. customize our build configurations based on the working / non-working hour or weekend (e.g. we would like to trigger 8 long running configurations in parallel during the night but would limit those to 1 or even disable them during office hours). I recently tried the http way of triggering a build with agentId=allEnabledCompatible during midnight, but since BT_MAX_RUNNING_BUILDS is set to 2 it only uses two agents at a time (while all others are idle).

Being able to define build configurations via an API would be extremely useful for our organization. We use very standardized combinations of multi-platform builds with snapshot dependencies and also packaging builds aggregated into image builds, themselves aggregated into cluster builds, with very standard artifact dependencies and build completion triggers. Currently, setting up one of these is about a 30 minute exercise of mindless clicking and cutting/pasting. Yes, templates help, and yes, copying projects and configurations help, but you still need to then go through and manually adjust the VCS roots and the dependencies, over and over again.

If anyone has written a plugin for themselves and is willing to share...

also requested in http://devnet.jetbrains.net/thread/304346

I put up on github.com a prototype of a dead-simple plugin that manages checkout rules for a given build config (helps in one-step branching in our environment).

Lots of room to expand, of course, but it's a start. It's derived from the samplePlugin.zip in the devPackage that ships with TeamCity, and tested against 6.0.3.

https://github.com/walquis/teamcity-plugin-vcsrootmanager

Cheers,

• chris
  

In it's simplest form, a plugin that would grab and release a lock on the actual project.xml files would be good enough to solve my problem. Is there any way to write that?

This is currently possible. No locks are exposed to the open API and so far it's not clear why we would need to do that. Can you describe why do you need the lock? It can be better to move this discussion into the forum as it seems to be a bit off the main issue.

I want to be able to safely modify the project.xml files while the TC master is running. I tried this in the past, and it caused all changes made via the web UI in the same project to be lost.

Provided the changes are not made simultaneously, that should not be the case. If you can reproduce this, it can be investigated separately.
Basically, changing xml is about the same as changing the settings from web UI: if there is a concurrent change, the last change wins.

Oh, I see you've created a thread on this: http://devnet.jetbrains.net/message/5304150#5304150
Let's continue there.

also requested in http://devnet.jetbrains.net/thread/311555

(Thanks for linking in my thread above, Michael.)

That this isn't available is a real bummer. An API that would provide our automation scripts a means to create new projects and build configurations, as well as manipulate existing ones, is practically essential for my organization's needs. If this were available in the TeamCity product, I'd select it over CCNet right this minute. Unfortunately, since it is not in the product, the decision has become pained.

This request was made 2 years ago; is it seriously being considered for addition to the REST API?

The company where I am currently working needs this too. This is very useful to apply mass modifications or to setup CI for new branches.

I also vote up this ticket. A very useful feature.

request to pause build configurations from a build script
http://devnet.jetbrains.net/thread/430524

Hi guys!

I've added some build configuration editing functionality into the current TeamCity trunk (7.0).
What is available now:

• empty project creation, empty build configurations, copying of projects and build configurations
  
• build configuration editing except for template operations.
  
• VCS roots creation and deletion, VCS root attaching with checkout rules, detaching from a build configuration

What is NOT available:

• nothing about build configuration template (no editing, not even viewing) UPDATE: this is already available in EAP, build 21075
  
• VCS root editing UPDATE: this will be available since build 21138 (not yet public)

TeamCity 7.0 release is planned very soon, within 6-8 weeks, so any early feedback on new REST API features is highly appreciated. If you do care about the functionality, please try it and let us know about any issues or thoughts. Posts to the forum and links here are welcome.

I am attaching current version of REST API plugin: rest-api_TW-8394_1.zip.
It should be compatible with the last TeamCity EAP, build 20939.
You can use the plugin in the latest EAP by copying the attached zip under .BuildServer\plugins
UPDATE: just use EAP build 21075

A tiny example of a step viewing and new creation:
curl -v --request GET http://user:pass@localhost:8111/app/rest/buildTypes/id:bt2/steps
curl -v --request GET http://user:pass@localhost:8111/app/rest/buildTypes/id:bt2/steps/RUNNER_1 -o response.xml
curl -v --request POST http://user:pass@localhost:8111/app/rest/buildTypes/id:bt2/steps --data-binary @response.xml --header "Content-Type: application/xml"

Build configuration copying:
curl -v --request POST http://user:pass@localhost:8111/app/rest/projects/id:project10/buildTypes --data "<newBuildTypeDescription name='Conf Name' sourceBuildTypeLocator='id:bt42' copyAllAssociatedSettings='true' shareVCSRoots='false'/>" --header "Content-Type: application/xml"

All the supported requests are listed in response to /app/rest/application.wadl request. You are also welcome to see not-so-pretty source code, if interested.

Great! My use-case (copy build configuration and modify its build parameters) can be successfully solved with this version.

I can also think of the following useful features:

• modify build configuration name (based on <buildLocator>)
  
• add/remove VCS root for build configuration (based on <buildLocator> and some <rootLocator> maybe)

And it would be great to have a bit more documentation too =)

Available via: curl -v --request PUT http://user:pass@localhost:8111/app/rest/buildTypes/id:bt2/name --data "New name"


Available in the above-described manner via:
curl http://user:pass@localhost:8111/app/rest/buildTypes/id:bt778/vcs-root-entries
curl -v --request GET http://user:pass@localhost:8111/app/rest/buildTypes/id:bt778/vcs-root-entries/id:3 -o response.xml
curl -v --request DELETE http://user:pass@localhost:8111/app/rest/buildTypes/id:bt2/vcs-root-entries/id:3
curl -v --request POST http://user:pass@localhost:8111/app/rest/buildTypes/id:bt2/vcs-root-entries --data-binary @response.xml --header "Content-Type: application/xml"


I would appreciate details on what needs the explanation most.
http://user:pass@localhost:8111/app/rest/application.wadl should list all the available requests. XML schema for the used entities will also be available in the next EAP.

UPDATED (to match recent TeamCity EAP)

a request to disable/enable agents http://devnet.jetbrains.net/thread/433046

curl -v –request POST http://user:pass@localhost:8111/app/rest/buildTypes/id:bt2/vcs-roots –data-binary @response.xml –header "Content-Type: application/xml" don't work for me =(
My workflow:
1) curl -v –request GET http://user:pass@localhost:8111/app/rest/vcs-roots/id:1 -o response.xml
2) change name and id in response.xml
3) curl -v –request POST http://user:pass@localhost:8111/app/rest/buildTypes/id:bt2/vcs-roots –data-binary @response.xml –header "Content-Type: application/xml"
What wrong?

Also, I think
curl -v –request GET http://user:pass@localhost:8111/app/rest/buildTypes/id:bt778/vcs-roots/id:3 -o response.xml
should work like
curl -v –request GET http://user:pass@localhost:8111/app/rest/vcs-roots/id:3 -o response.xml

not like just cropped version of
curl -v –request GET http://user:pass@localhost:8111/app/rest/buildTypes/id:bt778/vcs-roots -o response.xml

Sergey,

If you use attached version of the plugin with the latest TeamCity EAP, I'd appreciate a separate issue on this not to pollute this one.

Please describe what does "don't work for me" mean exactly - what is the output, what is in teamcity-rest.log, etc.

Your suggestion about buildTypes/XX/vcs-roots/YY vs vcs-roots/YY is probably another issue. However, as the entities returned are different, so far I could not agree.

Yegor, I create issue for first case.
http://youtrack.jetbrains.net/issue/TW-19802?projectKey=TW

Second comment is just my opinion, feel free to ignore it.

I have found the method to create vcs roots in the XML schema with http://localhost:8111/httpAuth/app/rest/vcs-roots/ however there is not documentation on what to POST. Is it possible to create a detached vcs root, then attach to a project afterwards?

John,

The schema should also be available, see <grammars> tag at the beginning of application.wadl
e.g. try http://localhost:8111/httpAuth/app/rest/application.wadl/xsd1.xsd

You are supposed to POST the same XML that you get on GET for an existing VCS root. The logic as for all other entities. I've updated the doc a bit on this.


Yes, that's how it works, search for "Attach VCS root to a build configuration" on the REST doc page.

Retrieving properties for VCS root is returning an error for me:

http://localhost:8111/httpAuth/app/rest/vcs-roots/id:2/properties/user

I vcs root 2 is a valid vcs root. I am doing a GET request. As per the documentation (GET/PUT http://teamcity:8111/httpAuth/app/rest/vcs-roots/<vcsRootLocator>/properties/<property_name>) I would expect this to return the value for the 'user' property for the vcs root. I am receiving:

Error has occurred during request processing (Not Found).
Error: com.sun.jersey.api.NotFoundException: null for uri: http://localhost:8111/app/rest/vcs-roots/id:2/properties/user
Please check URL is correct.

John,

Thank you for trying new additions to REST API. Could you please post a new issue or create a new forum thread so that we do not keep updating this issue?
Please include the build number that you are using and output of http://localhost:8111/app/rest/vcs-roots/id:2/properties request.

Is there a way to pause all build configurations using the rest api? I know how to get all the build configuration ids but was wondering if you could pause a build configuration using the rest api? The reason I ask is we have a test teamcity server where we test out the new versions with our currently running config files which have over 800 build configurations and when testing I don't want to have all the builds trigger. Do you guys have a recommendation on the best way to accomplish this? One idea I know of is to have one agent and just disable the agent but we are using EC2s on this test machine.

Thanks,
Jay

Jason,

In 7.0 you can PUT "false" to http://localhost:8111/app/rest/buildTypes/id:bt10/paused to pause a build configuration.
Also, in 7.0 in web UI you can move all the projects that you are not interested about in a separate agent pool with no agents.
Or make the connected agents compatible only with specific configurations on "Compatible Configurations" Agent tab.

Please post additional questions to the forum.

ah nice, I'll try the agent pool approach. Can we get a "select all" projects on the agent pool page? :)

Does anyone know if it is possible to send (POST) a command from an external (remote) program to TeamCity to start a build configuration? I would like to send a command via a program – any language – and start a build via the REST API or any other externally accessible API. Cheers!

Tony,

Triggering a build is not yet available via REST (TW-14941), but it can be done by doing the same request as user in web UI, see the documentation: http://confluence.jetbrains.net/display/TCD65/Accessing+Server+by+HTTP

BTW, please do not post generic questions here. The forum is a good place to ask questions, however.

Thank you Yegor for your response and assistance. And also thanks for the forum link – I will direct further questions there. Have a good day.