EnabledInfo
Contains information about agent availability (that is, whether it is ready to process builds). Send EnabledInfo objects to the /app/rest/agents/{agentLocator}/enabledInfo endpoint via PUT requests to manually enable and disable agents.
Related Help article: Build Agent
Properties
status
Returns true if the current object state is enabled (for example, pinned for build PinInfo or authorized for agent AuthorizedInfo; otherwise, false.
comment
Contains detailed information about current status value: the time it was set, the user who did it, and their personal notes on the event.This timestamp and the user data are automatically generated and cannot be changed.
statusSwitchTime
Returns date and time when the agent state should be automatically flipped. Specify this value to temporarily disable or enable agents, or leave it empty to permanently change the agent state (until it is updated manually).
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.