TeamCity REST API Reference 2024.07 Help

Tag

A single build tag. To remove a specific tag from a build, send a PUT request to the /app/rest/builds/BUILD_LOCATOR?locator=name:NAME endpoint with an empty name value.

Related Help article: Add Tags to Build

Properties

name

The public tag name visible in TeamCity UI.

owner

private

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.

<tag name="nightly" private="true"> <owner email="string" enabled2FA="true" hasPassword="true" href="string" id="123456789" lastLogin="string" locator="string" name="string" password="string" realm="string" username="string"> <properties>[[[properties...|properties.html]]]</properties> <roles>[[[roles...|roles.html]]]</roles> <groups>[[[groups...|groups.html]]]</groups> <avatars>[[[userAvatars...|useravatars.html]]]</avatars> </owner> </tag>
{ "owner" : { "lastLogin" : "lastLogin", "roles" : { "role" : [ "[[[role...|role.html]]]" ] }, "groups" : { "count" : 8, "group" : [ "[[[group...|group.html]]]" ] }, "hasPassword" : true, "password" : "password", "enabled2FA" : true, "name" : "name", "realm" : "realm", "id" : 3, "href" : "href", "locator" : "locator", "email" : "email", "properties" : { "count" : 1, "property" : [ { "inherited" : true, "name" : "name", "type" : "[[[type...|type.html]]]", "value" : "value" } ], "href" : "href" }, "username" : "username", "avatars" : { "urlToSize80" : "urlToSize80", "urlToSize28" : "urlToSize28", "urlToSize40" : "urlToSize40", "urlToSize32" : "urlToSize32", "urlToSize20" : "urlToSize20", "urlToSize64" : "urlToSize64", "urlToSize56" : "urlToSize56" } }, "private" : true, "name" : "nightly" }
Last modified: 23 September 2024