HealthItem

A single server health item that shows a server administrator a suggestion or notifies them about a misconfiguration or an error. Requests to the /app/rest/health endpoint return no health items if no locators are used. Use global:true to view server-related health items, project:project_id to view project-specific ones (project:(affectedProject:_Root) to view all of them), and add minSeverity:info/warn/error to filter by health item type.

Properties

identity

The unique health item ID.

severity

The health item severity. Supported values:

INFO for suggestions and minor issues.
WARN for issues that have no immediate negative impact.
ERROR for misconfigurations and issues that prevent normal server and/or project operations.

healthCategory

A health category that can group multiple identical health items.

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.

<healthItem identity="InternalDB_Warn" severity="WARN">
  <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"/>
</healthItem>

{
  "severity" : "WARN",
  "healthCategory" : {
    "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"
  },
  "identity" : "InternalDB_Warn"
}

Last modified: 02 December 2025