Child pages
  • REST API Plugin

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Info

The plugin is bundled since TeamCity 5.0. See the usage details in the current documentation version.

On this page:

Table of Contents

General Info

Vendor

JetBrains

License

Apache 2.0

Type

free, open-source

...

Exposes the TeamCity API via REST.

Info

The plugin is bundled since TeamCity 5.0

Usage

Details of the API usage are described at the version-specific pages:

...

REST API Versions

As REST API evolves from one TeamCity version to another, there can be incompatible changes in the protocol.
Under the http://teamcity:8111/app/rest/ URL the latest version is available.
Under http://teamcity:8111/app/rest/<version> URL, other versions CAN be available. Our general policy is to supply TeamCity with ONE previous version.
In TeamCity 7.x you can use "6.0" instead of <version> to get the previous version of the protocol.
In TeamCity 8.0 you can use "6.0" or "7.0" instead of <version> to get earlier versions of the protocol.

...

You can get details on errors and REST request processing in logs\teamcity-rest.log server log.
Please turn on debug logging (e.g. set Logging Preset to "debug-rest" on Administration/Diagnostics page or modify Log4J "jetbrains.buildServer.server.rest" category) to get details about each processed request.

Sources

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

...