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.

Properties

name

The public tag name visible in TeamCity UI.

owner

The user who owns this private tag. Present only for private tags and only when the requester has permission to view the owner's profile.

private

Returns true if this tag is private (visible only to its owner); false for public tags visible to all users.

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="false">
  <owner email="johndoe@example.com" enabled2FA="false" hasPassword="true" href="/app/rest/users/id:11" id="1" lastLogin="20241001T155514+0200" locator="null" name="John Doe" password="foobar" realm="string" username="johndoe">
    <properties>[[[properties...|properties.html]]]</properties>
    <roles>[[[roleAssignments...|roleassignments.html]]]</roles>
    <groups>[[[groups...|groups.html]]]</groups>
    <avatars>[[[userAvatars...|useravatars.html]]]</avatars>
  </owner>
</tag>

{
  "owner" : {
    "lastLogin" : "20241001T155514+0200",
    "roles" : {
      "role" : [ "[[[roleAssignment...|roleassignment.html]]]" ]
    },
    "groups" : {
      "count" : 2,
      "group" : [ "[[[group...|group.html]]]" ]
    },
    "hasPassword" : true,
    "password" : "foobar",
    "enabled2FA" : false,
    "name" : "John Doe",
    "realm" : "realm",
    "id" : 1,
    "href" : "/app/rest/users/id:11",
    "locator" : "null",
    "email" : "johndoe@example.com",
    "properties" : {
      "count" : 3,
      "property" : [ {
        "inherited" : false,
        "name" : "my.build.param",
        "type" : "[[[type...|type.html]]]",
        "value" : "production"
      } ],
      "href" : "/app/rest/buildTypes/id:MyBuild/parameters"
    },
    "username" : "johndoe",
    "avatars" : {
      "urlToSize80" : "/app/rest/avatars/id:1/80/avatar.a0b4af01-0211-4216-b2de-c295b282b4b5.png",
      "urlToSize28" : "/app/rest/avatars/id:1/28/avatar.a0b4af01-0211-4216-b2de-c295b282b4b5.png",
      "urlToSize40" : "/app/rest/avatars/id:1/40/avatar.a0b4af01-0211-4216-b2de-c295b282b4b5.png",
      "urlToSize32" : "/app/rest/avatars/id:1/32/avatar.a0b4af01-0211-4216-b2de-c295b282b4b5.png",
      "urlToSize20" : "/app/rest/avatars/id:1/20/avatar.a0b4af01-0211-4216-b2de-c295b282b4b5.png",
      "urlToSize64" : "/app/rest/avatars/id:1/64/avatar.a0b4af01-0211-4216-b2de-c295b282b4b5.png",
      "urlToSize56" : "/app/rest/avatars/id:1/56/avatar.a0b4af01-0211-4216-b2de-c295b282b4b5.png"
    }
  },
  "private" : false,
  "name" : "nightly"
}

Last modified: 18 August 2026