TeamCity REST API Reference 2026.2 Help

Plugin

Represents a plugin.

Properties

name

The internal name (identifier) of this plugin.

displayName

The human-readable display name of this plugin.

version

The version of this plugin.

loadPath

The file system path from which this plugin was loaded.

loaded

Indicates whether this plugin is currently loaded and active.

disabled

Indicates whether this plugin is disabled.

parameters

The configuration parameters of this plugin.

Schema

Below, you can find a full schema of this object, in XML and JSON formats. You can choose what fields to submit depending on your current needs. Different methods might expect different fields: the best approach is to request this entity via GET and use the response as a base for the following POST request.

A link to another object implies that you can substitute it with the schema of the linked object, if it is required for your call.

<plugin disabled="false" displayName="Build Version Plugin" loadPath="/opt/teamcity/plugins/bundled-build-version-plugin.zip" loaded="true" name="bundled-build-version-plugin" version="1.0.0"> <parameters count="3" href="/app/rest/buildTypes/id:MyBuild/parameters"> <property>[[[property...|property.html]]]</property> </parameters> </plugin>
{ "loaded" : true, "loadPath" : "/opt/teamcity/plugins/bundled-build-version-plugin.zip", "displayName" : "Build Version Plugin", "name" : "bundled-build-version-plugin", "disabled" : false, "version" : "1.0.0", "parameters" : { "count" : 3, "property" : [ { "inherited" : false, "name" : "my.build.param", "type" : "[[[type...|type.html]]]", "value" : "production" } ], "href" : "/app/rest/buildTypes/id:MyBuild/parameters" } }
Last modified: 18 August 2026