TeamCity REST API Reference 2022.10 Help

Node

Represents a TeamCity node.

Related Help article: Multi-node setup

Properties

Field

Data type

Allowed values

id

string

url

string

state

string

  • online

  • offline

  • stopping

  • starting

role

string

current

boolean

enabledResponsibilities

EnabledResponsibilities

disabledResponsibilities

DisabledResponsibilities

effectiveResponsibilities

EffectiveResponsibilities

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="string" role="string" state="string" url="string"> <enabledResponsibilities count="123"> <responsibility>[[[responsibility...|responsibility.html]]]</responsibility> </enabledResponsibilities> <disabledResponsibilities count="123"> <responsibility>[[[responsibility...|responsibility.html]]]</responsibility> </disabledResponsibilities> <effectiveResponsibilities count="123"> <responsibility>[[[responsibility...|responsibility.html]]]</responsibility> </effectiveResponsibilities> </node>
{ "current" : true, "enabledResponsibilities" : { "responsibility" : [ { "name" : "name", "description" : "description" } ], "count" : 4 }, "role" : "role", "disabledResponsibilities" : { "responsibility" : [ { "name" : "name", "description" : "description" } ], "count" : 7 }, "id" : "id", "state" : "online", "effectiveResponsibilities" : { "responsibility" : [ { "name" : "name", "description" : "description" } ], "count" : 1 }, "url" : "url" }
Last modified: 30 November 2022