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.
tip
Data type:
Environment
Example:
An Environment object that stores information about an operating system installed on the agent machine.
tip
Data type:
string
Example:Ubuntu-22.04-Large (ami-0123456ab78c9de0)
The name of a local agent or a cloud image that belongs to this type.
tip
Data type:
integer
Example:283
An integer value that is the unique agent identificator.
tip
Data type:
Properties
Example:
Returns a portion of availableParameters
list that contains only configuration parameters, excluding environment variables and system properties.
tip
Data type:
Properties
Example:
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
.
tip
Data type:
Properties
Example:
The list of all pre-defined and custom build parameters known to this agent.
tip
Data type:
Properties
Example:
Returns a portion of availableParameters
list that contains only system parameters, excluding environment variables and configuration parameters.
tip
Data type:
Properties
Example:
Returns a portion of availableParameters
list that contains only environment variables, excluding system and configuration parameters.
tip
Data type:
boolean
Example:false
Returns true if this type identifies agents spawned from a cloud image; false if this type identifies a local stand-alone agent.
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.
<agentType id="283" isCloud="false" name="Ubuntu-22.04-Large (ami-0123456ab78c9de0)">
<environment osName="Mac OS X, version 13.6" osType="macOS"/>
<configurationParameters count="123" href="string">
<property>property...</property>
</configurationParameters>
<buildParameters count="123" href="string">
<property>property...</property>
</buildParameters>
<availableParameters count="123" href="string">
<property>property...</property>
</availableParameters>
<systemParameters count="123" href="string">
<property>property...</property>
</systemParameters>
<environmentParameters count="123" href="string">
<property>property...</property>
</environmentParameters>
</agentType>
{
"environmentParameters" : {
"count" : 1,
"property" : [ {
"inherited" : true,
"name" : "name",
"type" : "type...",
"value" : "value"
} ],
"href" : "href"
},
"environment" : {
"osType" : "macOS",
"osName" : "Mac OS X, version 13.6"
},
"buildParameters" : {
"count" : 1,
"property" : [ {
"inherited" : true,
"name" : "name",
"type" : "type...",
"value" : "value"
} ],
"href" : "href"
},
"availableParameters" : {
"count" : 1,
"property" : [ {
"inherited" : true,
"name" : "name",
"type" : "type...",
"value" : "value"
} ],
"href" : "href"
},
"systemParameters" : {
"count" : 1,
"property" : [ {
"inherited" : true,
"name" : "name",
"type" : "type...",
"value" : "value"
} ],
"href" : "href"
},
"isCloud" : false,
"name" : "Ubuntu-22.04-Large (ami-0123456ab78c9de0)",
"id" : 283,
"configurationParameters" : {
"count" : 1,
"property" : [ {
"inherited" : true,
"name" : "name",
"type" : "type...",
"value" : "value"
} ],
"href" : "href"
}
}
Thanks for your feedback!