{hidden-data}

h1. Accessing Server from Scripts
{hidden-data}

In addition to the commands described here, there is a REST API that you can use for certain operations. When available, using REST API is a preferred way over one described here.

The examples below assume that your server web UI is accessible via http://teamcity.jetbrains.com:8111/ URL.

The TeamCity server supports basic HTTP authentication allowing to access certain web server pages and perform actions from various scripts. Please consult the manual for the client tool/library on how to supply basic HTTP credentials when issuing a request.

Use valid TeamCity server username and password to authenticate using basic HTTP authentication. The user should have appropriate permissions to perform the actions.

You may want to configure the server to use HTTPS as username and password are passed in insecure form during basic HTTP authentication.

To force using a basic HTTP authentication instead of redirecting to the login page if no credentials are supplied, prepend a path in usual TeamCity URL with "/httpAuth". For example:

http://teamcity.jetbrains.com:8111/httpAuth/action.html?add2Queue=MyBuildConf

The HTTP authentication can be useful when downloading build artifacts and triggering a build.

If you have Guest user enabled, it can be used to perform the action too. Use "/guestAuth" before the URL path to perform the action on Guest user behalf. For example:

http://teamcity.jetbrains.com:8111/guestAuth/action.html?add2Queue=MyBuildConf

Please make sure the user used to perform the authentication (or Guest user) has appropriate role to perform the necessary operation.

Triggering a Build From Script

Since TeamCity 8.1 the recommended and more feature-rich way to trigger a build is via REST API. The approach below will be removed in the future TeamCity versions.

To trigger a build, send the HTTP GET request for the URL: http://<server address>/httpAuth/action.html?add2Queue=<build configuration ID> performing basic HTTP authentication.

Some tools (for example, Wget) support the following syntax for the basic HTTP authentication:

http://<user name>:<user password>@<server address>/httpAuth/action.html?add2Queue=<build configuration Id>

Example:

http://testuser:testpassword@teamcity.jetbrains.com:8111/httpAuth/action.html?add2Queue=MyBuildConf

You can trigger a build on a specific agent passing additional agentId parameter with the agent's Id. You can get the agent Id from the URL of the Agent's details page (Agents page > <agent name>). For example, you can infer that agent's Id equals "2", if its details page has the following URL:

http://teamcity.jetbrains.com:8111/agentDetails.html?id=2

To trigger a build on two agents at the same time, use the following URL:

http://testuser:testpassword@teamcity.jetbrains.com:8111/httpAuth/action.html?add2Queue=MyBuildConf&agentId=1&agentId=2

To trigger a build on all enabled and compatible agents, use "allEnabledCompatible" as agent ID:

http://testuser:testpassword@teamcity.jetbrains.com:8111/httpAuth/action.html?add2Queue=MyBuildConf&agentId=allEnabledCompatible

Triggering a Custom Build

TeamCity allows you to trigger a build with customized parameters. You can select particular build agent to run the build, define additional properties and environment variables, and select the particular sources revision (by specifying the last change to include in the build) to run the build with. These customizations will affect only the single triggered build and will not affect other builds of the build configuration.

To trigger a build on a specific change inclusively, use the following URL:

http://testuser:testpassword@teamcity.jetbrains.com:8111/httpAuth/action.html?add2Queue=MyBuildConf&modificationId=11112

modificationId — modification/change internal id which can be obtained from the web diff url.

To trigger a build with custom parameters (system properties and environment variables), use:

http://testuser:testpassword@teamcity.jetbrains.com:8111/httpAuth/action.html?add2Queue=MyBuildConf&name=<full property name1>&value=<value1>&name=<full property name2>&value=<value2>

Where <full property name> is a full property name with system./env. prefix or no prefix to define configuration parameter.
Please note that previous TeamCity versions used different syntax for this action. That syntax is still supported for compatibility reason, though.

To move build to the top of the queue, add the following to the query string

To run a personal build, add &personal=true to the query string.

To run a build on a feature branch:

http://testuser:testpassword@teamcity.jetbrains.com/httpAuth/action.html?add2Queue=bt10&branchName=master