TeamCity REST API Reference 2026.2 Help

Link

Represents a single URL link associated with a TeamCity entity, with a type that identifies its purpose. For example, a webView link opens the entity page in the TeamCity UI.

Properties

type

The link purpose. Possible values:

  • webView — a URL that opens the entity in the TeamCity web UI.

  • webEdit — a URL that opens the entity editor in the TeamCity web UI.

  • webViewSettings — a URL that opens the entity settings page in the TeamCity web UI.

url

The absolute URL of this link.

relativeUrl

The relative (without the TeamCity server URL) version of this link.

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.

<link relativeUrl="/buildConfiguration/MyProject_Build/22011" type="webView" url="http://teamcity.example.com/buildConfiguration/MyProject_Build/22011"/>
{ "type" : "webView", "relativeUrl" : "/buildConfiguration/MyProject_Build/22011", "url" : "http://teamcity.example.com/buildConfiguration/MyProject_Build/22011" }
Last modified: 18 August 2026