Patterns For Accessing Build Artifacts

Skip to end of metadata
Go to start of metadata
You are viewing documentation of TeamCity 6.5.x, which is not the most recent released version of TeamCity. Please refer to the listing to choose another version.
Search

Searching TeamCity 6.5.x Documentation

Table of Contents

This section covers URL patterns that you may use to download build artifacts from outside of TeamCity.
See Accessing Server by HTTP on basic rules covering HTTP access from scripts.

You may also download artifacts from TeamCity using Ivy dependency manager.
If you need to access the artifacts in your builds, consider using TeamCity's built-in Artifact Dependency feature.

This page covers:

Obtaining Artifacts

Use the following patterns to download artifacts:

To download artifacts of the latest builds (last finished, successful or pinned), use the following paths:

To download artifacts by build id, use:

To download artifacts by build number, use:

To download all artifacts in a .zip archive, use:

(BUILD_ID:id can be substituted with ".lastFinished", ".lastSuccessful" or ".lastPinned" without quotes)
or

By default, archive with all artifacts does not include hidden artifact. To include them, add "?showAll=true" to the end of the corresponding URL.

where

  • BUILD_TYPE_ID is a build configuration ID or build configuration full name, that is, <project name>::<build configuration name>
  • BUILD_NUMBER is a build number
  • BUILD_ID is a build ID
  • ARTIFACT_PATH is a path to artifact in TeamCity server. This path may contain a {build.number} pattern , this pattern will be replaced with build number of the build whose artifact is retrieved.

Obtaining Artifacts from an Archive

TeamCity allows to obtain a file from any zip/jar archive from the build artifacts directory, using one of the following URL patterns:

Pattern 1

where:

  • BUILD_TYPE_ID is a build configuration ID
  • lastFinished | lastSuccessful | lastPinned is an identifier for the build instance

Pattern 2

where 

  • BUILD_TYPE_ID is a build configuration ID 
  • BUILD_NUMBER is a build number 

Obtaining Artifacts from a Build Script

It is often required to download artifacts of some build configuration by tools like wget or another downloader which does not support HTML login page. TeamCity asks for authentication if you accessing artifacts repository.

To authenticate correctly from a build script, you have to change URLs (add /httpAuth/ prefix to the URL):

Basic authentication is required for accessing artifacts by this URLs with /httpAuth/ prefix. You can use existing TeamCity username and password in basic authentication settings.

To enable downloading an artifact with guest user login, you can use either of the following methods:

  • Use old URLs without /httpAuth/ prefix, but with added guest=1 parameter. For example:
  • Add the /guestAuth prefix to the URLs, instead of using guest=1 parameter. For example:

In this case you will not be asked for authentication.
The list of the artifacts can be found in /repository/download/BUILD_TYPE_ID/.lastFinished/teamcity-ivy.xml.

Links to the Artifacts Containing the TeamCity Build Number

You can use {build.number} as a shortcut to current build number in the artifact file name.
For example:


Obtaining all artifacts in a single archive

TeamCity allows to download all artifacts packed in a zip archive using any of the following links:

where {build.number} and {build.type} denote the build id and build configuration id respectively.



See also:

Concepts: Build Artifact | Authentication Scheme
Administrator's Guide: Retrieving artifacts in builds
Extending TeamCity: Accessing Server by HTTP

Labels:

artifact artifact Delete
build build Delete
pattern pattern Delete
admin admin Delete
server server Delete
Enter labels to add to this page:
Wait Image 
Looking for a label? Just start typing.
  1. Nov 21, 2011

    Should also work for tagged builds:
    /repository/download/BUILD_TYPE_ID/<tag_value>.tcbuildtag/ARTIFACT_PATH
    e.g. http://localhost:8111/repository/download/bt19/beta.tcbuildtag/dist/installer.zip