TeamCity REST API Reference 2025.11 Help

AgentRequirement

A build configuration's (or template's) requirement for agent parameters. Non-compliant agents cannot run builds spawned by the configuration.

Related Help article: Agent Requirements

Properties

id

The internal read-only ID of the object. This property is inherited from the base PropEntity class.

name

The public object name. Some objects, like build steps, support public names, while others, like build triggers, do not. This property is inherited from the base PropEntity class.

type

The object type. This property is inherited from the base PropEntity class.

disabled

Returns rue if the object is disabled and inactive; otherwise, false. This property is inherited from the base PropEntity class.

inherited

Returns rue if the object is inherited from another object; otherwise, false. This property is inherited from the base PropEntity class.

href

Returns the shortened (without the server URL) link to the current object. This property is inherited from the base PropEntity class.

properties

The list of main object settings. Each setting is a Property instance with name and value fields. This property is inherited from the base PropEntity class.

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.

<agent-requirement disabled="false" href="string" id="TRIGGER_71" inherited="false" name="Py: Merge reports" type="simpleRunner, commit-status-publisher, vcsTrigger"> <properties count="123" href="string"> <property>[[[property...|property.html]]]</property> </properties> </agent-requirement>
{ "inherited" : false, "name" : "Py: Merge reports", "disabled" : false, "id" : "TRIGGER_71", "href" : "href", "type" : "simpleRunner, commit-status-publisher, vcsTrigger", "properties" : { "count" : 1, "property" : [ { "inherited" : true, "name" : "name", "type" : "[[[type...|type.html]]]", "value" : "value" } ], "href" : "href" } }
Last modified: 02 December 2025