Node

Represents a TeamCity node.

Properties

id

The unique identifier of this TeamCity node in the multi-node cluster.

url

The URL of this TeamCity node.

state

The current operational state of this node. Possible values:

online — the node is running and accepting requests.
offline — the node is not reachable.
starting — the node is starting up and not yet ready to accept requests.
stopping — the node is in the process of shutting down.

role

The role of this node in the multi-node cluster. Possible values:

main_node — the primary node that handles all write operations and build queue.
secondary_node — a read-only node that offloads specific responsibilities from the main node.

current

Returns true if this node is the one currently handling this API request; otherwise, false.

enabledResponsibilities

The list of responsibilities currently enabled on this node.

disabledResponsibilities

The list of responsibilities that are assignable but currently disabled on this node.

effectiveResponsibilities

The list of responsibilities that are effectively active on this node.

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.

<node current="true" id="MAIN_SERVER" role="main_node" state="online" url="http://teamcity-node1:8111">
  <enabledResponsibilities count="3">
    <responsibility>[[[responsibility...|responsibility.html]]]</responsibility>
  </enabledResponsibilities>
  <disabledResponsibilities count="2">
    <responsibility>[[[responsibility...|responsibility.html]]]</responsibility>
  </disabledResponsibilities>
  <effectiveResponsibilities count="3">
    <responsibility>[[[responsibility...|responsibility.html]]]</responsibility>
  </effectiveResponsibilities>
</node>

{
  "current" : true,
  "enabledResponsibilities" : {
    "responsibility" : [ {
      "name" : "CAN_PROCESS_BUILD_TRIGGERS",
      "description" : "Processing build triggers"
    } ],
    "count" : 3
  },
  "role" : "main_node",
  "disabledResponsibilities" : {
    "responsibility" : [ {
      "name" : "CAN_PROCESS_BUILD_TRIGGERS",
      "description" : "Processing build triggers"
    } ],
    "count" : 2
  },
  "id" : "MAIN_SERVER",
  "state" : "online",
  "effectiveResponsibilities" : {
    "responsibility" : [ {
      "name" : "CAN_PROCESS_BUILD_TRIGGERS",
      "description" : "Processing build triggers"
    } ],
    "count" : 3
  },
  "url" : "http://teamcity-node1:8111"
}

Last modified: 18 August 2026