AgentType
The agent type that describes common properties shared by all agents of this type. Stand-alone local agents are the only representatives of their corresponding types, whereas cloud agents spawned from the same cloud image belong to the same type.
Properties
availableParameters
The list of all pre-defined and custom build parameters known to this agent.
configurationParameters
Returns a portion of `availableParameters` list that contains only configuration parameters, excluding environment variables and system properties.
systemParameters
Returns a portion of `availableParameters` list that contains only system parameters, excluding environment variables and configuration parameters.
environmentParameters
Returns a portion of `availableParameters` list that contains only environment variables, excluding system and configuration parameters.
buildParameters
Returns a list of agent parameters that are accessible by builds running on an agent of this type. Typically returns a combination of `environmentParameters` and `systemParameters`.
isCloud
Returns true if this type identifies agents spawned from a cloud image; false if this type identifies a local stand-alone agent.
environment
An Environment object that stores information about an operating system installed on the agent machine.
name
The name of a local agent or a cloud image that belongs to this type.
id
An integer value that is the unique agent identificator.
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.