JetBrains TeamCity REST API
TeamCity REST API enables agents to trigger and monitor builds, manage build configurations and projects, query test results and build artifacts, and administer users and agents on JetBrains TeamCity CI/CD servers.
Score Breakdown
⚙ Agent Friendliness
🔒 Security
Token-based auth supports role-based permission scoping. Build parameters and secrets can be defined as password-type parameters that are masked in logs. On-premises TLS configuration is operator responsibility.
⚡ Reliability
Best When
Best when your enterprise already runs TeamCity and needs agents to deeply integrate with its rich build configuration model, test intelligence, and artifact management without switching platforms.
Avoid When
Avoid when the operational complexity of self-hosting TeamCity (or the cost of TeamCity Cloud) outweighs the benefits compared to simpler CI alternatives.
Use Cases
- • Trigger a specific build configuration with custom parameters after a release branch is cut
- • Query test failure details and flaky test statistics to populate a QA dashboard automatically
- • Pin a successful build and download artifacts for deployment pipeline integration
- • Create or clone build configurations programmatically during new service scaffolding
- • Monitor build queue depth and agent pool utilization to auto-scale cloud agents
Not For
- • Small teams or open-source projects that need a lightweight, low-ops CI solution
- • Organizations without a dedicated CI/CD administrator familiar with TeamCity's configuration model
- • Workflows that require a fully SaaS-hosted option with no on-premises footprint
Interface
Authentication
Supports HTTP Basic authentication (username:password) and token-based authentication via a Bearer token generated in the TeamCity UI. Token-based auth is recommended for agents. Tokens can be scoped to specific permissions. Guest auth can be enabled for read-only access on non-sensitive instances.
Pricing
The Professional tier is genuinely free with no time limit. Enterprise adds unlimited configurations, additional agents, and enterprise support. TeamCity Cloud offers pay-as-you-go credits.
Agent Metadata
Known Gotchas
- ⚠ API responses default to XML; agents must send Accept: application/json header explicitly to receive JSON, otherwise XML parsing is required
- ⚠ Locator syntax (e.g., buildType:(id:MyBuild),branch:(name:main)) is powerful but has undocumented edge cases and is easy to get wrong
- ⚠ Build queue vs. running builds are separate API resources — agents polling for completion must check both endpoints depending on build state
- ⚠ Personal builds and default builds use different endpoints; agents triggering per-user builds need to handle the personal build locator pattern
- ⚠ Large artifact downloads stream through the TeamCity server and can saturate server bandwidth — agents should use direct artifact storage URLs when available
Alternatives
Full Evaluation Report
Detailed scoring breakdown, competitive positioning, security analysis, and improvement recommendations for JetBrains TeamCity REST API.
Scores are editorial opinions as of 2026-03-06.