Hanzo
PlatformHanzo KMSIntegrationsApp Connections

TeamCity Connection

Learn how to configure a TeamCity Connection for Hanzo KMS.

Hanzo KMS supports connecting to TeamCity using Access Tokens.

Setup TeamCity Connection in Hanzo KMS

Navigate to the TeamCity Profile page by clicking on your profile icon in the bottom-left corner. TeamCity Main Page

Select the Access Tokens tab from the left sidebar navigation menu. TeamCity Token Page

Click the Create access token button and provide a name for your token (e.g., "Hanzo KMS Integration"). You may set an expiration date or leave it blank for no expiry. The permission scope can either be Same as current user or Limit per project.

If you're choosing Limit per project, make sure you select the relevant project and enable the permissions relevant to your use case:

  • View build configuration settings
  • Edit project

TeamCity Token Popup

Setting your permission scope to Same as current user will allow your integration to access multiple projects as long as the current user has read and write access to them.

If you configure an expiry date for your access token, you must manually rotate to a new token before the expiration date to prevent service interruption.

After creation, a modal with the Access Token will be displayed. Copy this token immediately and store it securely, as you won't be able to view it again after closing this dialog. TeamCity Token Copy Popup

You should now see your newly created token in the list of access tokens. TeamCity Token Created

  1. Navigate to App Connections

    In your Hanzo KMS dashboard, navigate to the Integrations tab in the desired project, then select App Connections. App Connections Tab

  2. Add Connection

    Click the + Add Connection button and select the TeamCity Connection option from the available integrations. Select TeamCity Connection

  3. Fill the TeamCity Connection Modal

    Complete the TeamCity Connection form by entering:

    • A descriptive name for the connection
    • The Access Token you generated in steps 3-4
    • The URL of your TeamCity instance
    • An optional description for future reference

    TeamCity Connection Modal

  4. Connection Created

    After clicking Create, your TeamCity Connection is established and ready to use with your Hanzo KMS project. TeamCity Connection Created

To create a TeamCity Connection, make an API request to the Create TeamCity Connection API endpoint.

Sample request

curl    --request POST \
        --url https://app.kms.hanzo.ai/api/v1/app-connections/teamcity \
        --header 'Content-Type: application/json' \
        --data '{
            "name": "my-teamcity-connection",
            "method": "access-token",
            "projectId": "7ffbb072-2575-495a-b5b0-127f88caef78",
            "credentials": {
                "accessToken": "...",
                "instanceUrl": "https://yourcompany.teamcity.com"
            }
        }'

Sample response

{
  "appConnection": {
    "id": "e5d18aca-86f7-4026-a95e-efb8aeb0d8e6",
    "name": "my-teamcity-connection",
    "projectId": "7ffbb072-2575-495a-b5b0-127f88caef78",
    "description": null,
    "version": 1,
    "orgId": "6f03caa1-a5de-43ce-b127-95a145d3464c",
    "createdAt": "2025-04-23T19:46:34.831Z",
    "updatedAt": "2025-04-23T19:46:34.831Z",
    "isPlatformManagedCredentials": false,
    "credentialsHash": "7c2d371dec195f82a6a0d5b41c970a229cfcaf88e894a5b6395e2dbd0280661f",
    "app": "teamcity",
    "method": "access-token",
    "credentials": {
      "instanceUrl": "https://yourcompany.teamcity.com"
    }
  }
}

How is this guide?

Last updated on

On this page