Penv Cloud
Start free
Docs
Reference

TeamCity project parameters

Sync an environment with one TeamCity project's env. parameters.

Sync an environment with one TeamCity project's env. parameters.

Connection

WhatThis provider
VendorJetBrains TeamCity
Keyteamcity-parameters
Availabilityavailable. You can connect it today.
Credential we holdteamcity-token
Values read backyes
Activationon-next-deploy

Directions

DirectionWhat it does
importWe read names and values out of the store into your environment.
exportWe write names and values from your environment into the store.

Activation

on-next-deploy. A new value waits there and arrives with your next deploy.

Conflict policies

DirectionPolicies you can pick
importskip_existing, new_version, fail
exportcreate_only, overwrite, overwrite_and_prune

How syncs work says what each one does.

Connect

Paste a credential from the vendor. We seal it and never show it again.

FieldLabelKindRequiredWhat it is
tokenAccess tokensecret; we mask it here and seal ityesFrom your profile, Access Tokens. Your account needs View build configuration settings on the project, plus Edit project to export.

Connection fields

You set these when you connect. Every mapping on the connection shares them.

FieldLabelKindRequiredAdvancedWhat it is
hostServer URLtextyesnoYour server's https:// address. It must be reachable from the internet for us to write to it.

Mapping fields

You answer these once per environment you map.

FieldLabelKindRequiredAdvancedWhat it is
projectIdProject IDtextyesnoFrom the project's General Settings. We write each key as env.KEY, never touch parameters inherited from a parent project, and refuse a value containing %, which TeamCity reads as a reference. If the project keeps its settings in version control, TeamCity can refuse a write or replace it with the repository's copy; with two-way synchronization, each write is committed to that repository. Pruning deletes every env. parameter of this project that this environment lacks, including ones this sync did not write.
passwordWrite values as password parametersyes or noyesyesTeamCity never returns a password value, including to import. We never turn a password parameter back into text. Starts at true.

Required permissions

We probe for these when we verify the connection.

PermissionDirectionsBlockingWithout it
VIEW_BUILD_CONFIGURATION_SETTINGSevery directionyesPreview cannot list the project's parameters.
EDIT_PROJECTexportyesExport cannot add, change or remove a parameter.