TeamCity Cloud 2026.3 Help

Managing Jobs

Jobs represent build configurations in TeamCity. The teamcity job command group lets you create, list, and view build configurations, manage their build steps, pause and resume them, and manage their parameters.

Creating a job

Create a new build configuration in a project. The parent project comes from --project, the TEAMCITY_PROJECT environment variable, or the linked project (see Linking):

teamcity job create Build --project MyProject

By default TeamCity derives the job ID from the name. Set an explicit ID with --id, or base the new job on an existing template with --template:

teamcity job create Build --project MyProject --id MyProject_Build teamcity job create Build --project MyProject --template MyTemplate

Add --web to open the new job in your browser, or --json for machine-readable output.

Listing jobs

List build configurations across all projects. Jobs backed by pipelines are hidden by default — pass --all to include them:

teamcity job list teamcity job list --all
Listing and filtering jobs

Filter by project:

teamcity job list --project MyProject

Limit the number of results (use --limit 0 to fetch all):

teamcity job list --limit 20 teamcity job list --limit 0

Output as JSON:

teamcity job list --json teamcity job list --json=id,name,projectName,webUrl

job list flags

Flag

Description

-p, --project

Filter by project ID

--all

Include jobs backed by pipelines (hidden by default)

-n, --limit

Maximum number of jobs to display (use 0 for all)

--json

Output as JSON. Use --json= to list available fields, --json=f1,f2 for specific fields.

Viewing job details

View details of a build configuration:

teamcity job view MyProject_Build

Open the job page in your browser:

teamcity job view MyProject_Build --web

Output as JSON:

teamcity job view MyProject_Build --json

Dependency tree

Visualize the snapshot dependency chain for a job. By default, the tree shows both dependents (what gets triggered after this job) and dependencies (what must run before this job):

teamcity job tree MyProject_DeployStaging
Viewing job dependency trees

Show only one direction:

teamcity job tree MyProject_Build --only dependents teamcity job tree MyProject_Deploy --only dependencies

Limit the tree depth:

teamcity job tree MyProject_Build --depth 2

job tree flags

Flag

Description

-d, --depth

Limit tree depth (0 = unlimited)

--only

Show only dependents or dependencies

Managing build steps

Build steps are the individual runners a job executes in order. List the steps on a job:

teamcity job step list MyBuild

View one step's full configuration, including its parameter keys:

teamcity job step view MyBuild RUNNER_1

Add a step. --type is the runner type ID used by TeamCity's REST API, which differs from the display name in the UI — Command Line is simpleRunner, Gradle is gradle-runner, Maven is Maven2. Repeat --param key=value for each runner setting:

teamcity job step add MyBuild --type simpleRunner --name "Run Tests" --param use.custom.script=true --param script.content="./gradlew test"

Delete a step by its ID:

teamcity job step delete MyBuild RUNNER_1

Pausing and resuming jobs

Pause a job to prevent new builds from being triggered:

teamcity job pause MyProject_Build

Resume a paused job to allow new builds:

teamcity job resume MyProject_Build

Managing job parameters

Listing parameters

View all parameters defined on a job:

teamcity job param list MyProject_Build teamcity job param list MyProject_Build --json

Getting a parameter value

Retrieve the value of a specific parameter:

teamcity job param get MyProject_Build VERSION teamcity job param get MyProject_Build env.JAVA_HOME

Setting a parameter

Set or update a parameter value:

teamcity job param set MyProject_Build VERSION "2.0.0"

To mark a parameter as secure (password field), use the --secure flag. Secure parameters have their values hidden in the web interface and build logs:

teamcity job param set MyProject_Build SECRET_KEY "my-secret-value" --secure

Deleting a parameter

Remove a parameter from a job:

teamcity job param delete MyProject_Build MY_PARAM

Managing job settings

Settings are the build-configuration options that control how a job runs — build number format, execution timeout, artifact rules, and similar. Unlike parameters, settings always have server defaults and cannot be deleted.

Listing settings

View all settings defined on a job:

teamcity job settings list MyProject_Build teamcity job settings list MyProject_Build --json

Getting a setting value

Retrieve the value of a specific setting:

teamcity job settings get MyProject_Build buildNumberPattern teamcity job settings get MyProject_Build executionTimeoutMin

Setting a value

Set or update a setting value:

teamcity job settings set MyProject_Build buildNumberPattern "2.0.%build.counter%" teamcity job settings set MyProject_Build executionTimeoutMin 30
26 October 2026