TeamCity REST API Reference 2025.11 Help

HealthCategory

A health category that groups identical health items. Categories that group server-wide issues (/app/rest/health?locator=global:true) typically have one health item, whereas categories for project-specific issues can group multiple identical health items (one for each project where the issue manifests).

Related Help article: Server Health

Properties

id

The unique health category ID.

name

The public category name displayed in TeamCity UI as the category header.

description

The nullable health category description.

helpUrl

The link to TeamCity documentation or other resource that contains information on how to resolve a corresponding issue.

Schema

Below, you can find a full schema of this object, in XML and JSON formats. You can choose what fields to submit depending on your current needs. Different methods might expect different fields: the best approach is to request this entity via GET and use the response as a base for the following POST request.

A link to another object implies that you can substitute it with the schema of the linked object, if it is required for your call.

<healthCategory description="Domain isolation protection for artifacts is disabled. To secure the server, consider enabling the protection and configuring the URL in Global Settings." helpUrl="https://www.jetbrains.com.cn/en-us/help/teamcity/2025.11/?Server+Health#ServerHealth-db" id="UnavailableTokenReportWrongScopeCategory" name="VCS Root or Build Feature uses the token that was issued for a different project"/>
{ "name" : "VCS Root or Build Feature uses the token that was issued for a different project", "description" : "Domain isolation protection for artifacts is disabled. To secure the server, consider enabling the protection and configuring the URL in Global Settings.", "helpUrl" : "https://www.jetbrains.com.cn/en-us/help/teamcity/2025.11/?Server+Health#ServerHealth-db", "id" : "UnavailableTokenReportWrongScopeCategory" }
Last modified: 02 December 2025