Child pages
  • REST API Plugin
Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 17 Next »

General Info

Vendor

JetBrains

License

Apache 2.0

Type

free, open-source

Plugin Description

Exposes TeamCity API via REST.

Icon

The plugin is bundled with TeamCity 5.0

Usage

If your server is accessible via http://teamcity:8111/ URL, use:
http://teamcity:8111/httpAuth/app/rest/application.wadl - to the get list of supported requests and names of parameters

For example:
http://teamcity:8111/httpAuth/app/rest/version - to get plugin version
http://teamcity:8111/httpAuth/app/rest/projects - to get projects list, then follow href's
http://teamcity:8111/httpAuth/app/rest/buildTypes/id:bt284/builds?status=SUCCESS&tag=EAP - (example ids are used) to get builds

As a rule, single value responses are "text/plain" and complex value responses support both "application/xml" and "application/json". Supply appropriate "Accept" header in the request to get necessary response type.

Feel free to ask questions and provide feedback in our plugins forum.

Build Tags

Get tags: GET {{http://teamcity:8111/httpAuth/app/rest/builds/

Unknown macro: {buildLocator}

/tags/}}
Replace tags: PUT {{http://teamcity:8111/httpAuth/app/rest/builds/

/tags/}} (should put the same XML of JSON as returned by GET)
Add tags: POST {{http://teamcity:8111/httpAuth/app/rest/builds/

Unknown macro: {buildLocator}

/tags/}} (should post the same XML of JSON as returned by GET)

Development links

Sources

If you need to extend the plugin with your functionality, you can base your plugin on the current REST API plugin code, but ensure that your plugin does not interfere with the bundled REST plugin. To achieve this, change teamcity-plugin.xml file to have different plugin name and different value for "api.path" parameter. Once this is done, your patched plugin and original REST api plugin can work in the single TeamCity installation.

TeamCity Versions Compatibility

TeamCity 5.0 and above.

  • No labels