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
| What | This provider |
|---|---|
| Vendor | JetBrains TeamCity |
| Key | teamcity-parameters |
| Availability | available. You can connect it today. |
| Credential we hold | teamcity-token |
| Values read back | yes |
| Activation | on-next-deploy |
Directions
| Direction | What it does |
|---|---|
import | We read names and values out of the store into your environment. |
export | We 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
| Direction | Policies you can pick |
|---|---|
import | skip_existing, new_version, fail |
export | create_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.
| Field | Label | Kind | Required | What it is |
|---|---|---|---|---|
token | Access token | secret; we mask it here and seal it | yes | From 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.
| Field | Label | Kind | Required | Advanced | What it is |
|---|---|---|---|---|---|
host | Server URL | text | yes | no | Your 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.
| Field | Label | Kind | Required | Advanced | What it is |
|---|---|---|---|---|---|
projectId | Project ID | text | yes | no | From 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. |
password | Write values as password parameters | yes or no | yes | yes | TeamCity 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.
| Permission | Directions | Blocking | Without it |
|---|---|---|---|
VIEW_BUILD_CONFIGURATION_SETTINGS | every direction | yes | Preview cannot list the project's parameters. |
EDIT_PROJECT | export | yes | Export cannot add, change or remove a parameter. |