Skip to main content

TeamCity

Access TeamCity CI/CD — browse projects and build configurations, inspect builds, tests and failures, trigger and cancel builds, and manage investigations and mutes.

Categories: CI/CD, DevOps

Set up​

TeamCity connects with credentials from your TeamCity account. Have these values ready:

  • Server address
  • Access token
  1. Go to Organization > Connectors and find TeamCity.
  2. Click Enable and choose which tools to allow.
  3. Each member enters their own values the first time they use it.

To use one account for the whole organization, turn on Share one connection with everyone. Every member's agents then act as that account, with exactly the access it has.

Tools​

TeamCity offers 57 tools. Admins choose which ones agents can use. See Tool permission groups.

Read (36)​

View and search information without changing it.

ToolWhat it does
get_agentGet one build agent by ID, including version, IP, pool and enabled state.
get_buildGet one build by ID, including status, timings, agent and what triggered it.
get_build_logGet a bounded slice of a build's log as plain text.
get_build_statisticsGet a build's recorded statistics as name/value pairs, such as BuildDuration, ArtifactsSize, AllTestsDuration and SuccessRate.
get_build_typeGet a single build configuration by ID.
get_changeGet one VCS change by ID, including the list of files it touched.
get_projectGet a single TeamCity project by ID.
get_queued_buildGet one queued build by ID, including its queue position, wait reason and estimated start.
get_server_infoGet TeamCity server version, build number, start time and web URL.
get_test_occurrenceGet one test run including its failure details and stack trace.
get_userGet one TeamCity user by ID or username, including role assignments and group memberships.
get_vcs_rootGet one VCS root by ID.
list_agent_poolsList agent pools, which group build agents and scope them to projects.
list_agentsList build agents with their connection and enabled state.
list_build_artifactsList files and directories in a build's artifacts.
list_build_tagsList the tags on a build.
list_build_type_branchesList branches known to a build configuration, flagging the default and which are active.
list_build_type_parametersList a build configuration's build parameters, including those inherited from its project or template.
list_build_type_stepsList a build configuration's build steps, with each step's runner type and whether it is disabled.
list_build_type_triggersList a build configuration's build triggers (VCS, schedule, dependency) and whether each is disabled.
list_build_type_vcs_rootsList the VCS roots attached to a build configuration, with their checkout rules.
list_build_typesList build configurations with server-side filtering by project, name, or paused state.
list_buildsList builds with server-side filtering by configuration, project, branch, status, state, agent, user, tag or date.
list_changesList VCS changes (commits) with their messages and authors.
list_investigationsList investigations — who has taken ownership of which failures.
list_mutesList muted tests and build problems — failures deliberately hidden from build status.
list_problem_occurrencesList non-test build failures (compilation errors, exit codes, dependency failures) with their failure messages.
list_problemsLook up build problems by their server-wide identity, to answer 'what is failing or muted in this project'.
list_project_parametersList a project's build parameters, which its build configurations inherit.
list_projectsList TeamCity projects with server-side filtering by name, archived state, or parent.
list_queued_buildsList builds waiting in the build queue, with each one's queue position and why it has not started.
list_test_occurrencesList individual test runs, filtered by build, configuration, status, or branch.
list_testsLook up tests by their server-wide identity, to answer 'what is failing or muted in this project'.
list_usersList TeamCity users filtered by username, name, email or group.
list_vcs_rootsList VCS roots (configured repository connections) filtered by name, provider type or project.
validate_credentialValidate the TeamCity server URL and access token by fetching the current user.

Write (7)​

Create or send data.

ToolWhat it does
add_build_tagsAdd one or more tags to a build.
create_build_typeCreate a build configuration in a project. name and project_id are both required — use list_projects to find a valid project_id.
create_investigationAssign an investigation so a named user owns a failure.
create_muteMute failing tests or build problems so they stop failing builds.
create_projectCreate a TeamCity project.
trigger_buildQueue a new build. build_type_id is required — get it from list_build_types.
trigger_vcs_checkAsk TeamCity to check a VCS root for new commits now, instead of waiting for its polling interval.

Delete or overwrite (14)​

Remove or replace existing data.

ToolWhat it does
cancel_buildCancel a RUNNING build, optionally re-queueing an identical one.
cancel_queued_buildRemove a build from the queue before it starts.
delete_build_typePermanently delete a build configuration and its build history.
delete_investigationDelete an investigation, releasing ownership of the failure.
delete_muteUnmute a test or build problem so its failures count again.
delete_projectPermanently delete a TeamCity project along with all of its build configurations and build history.
delete_project_parameterDelete a single build parameter from a project.
set_agent_enabledEnable or disable a build agent.
set_build_commentSet or replace the comment on a build, for example to record why it was kept or what it shipped.
set_build_pinPin or unpin a build.
set_build_type_parameterCreate or update a single build parameter on a build configuration.
set_build_type_pausedPause or resume a build configuration.
set_project_parameterCreate or update a single build parameter on a project.
set_queue_pausedPause or resume the entire TeamCity build queue server-wide.
⌘J