AgentApi

getAllAgents

Get all known agents.


Endpoint	/app/rest/agents
Produces	`application/xml` `application/json`
Parameters	`locator: string<AgentLocator>` `fields: string`
Response	`Agents`

Delete an inactive agent.


Endpoint	/app/rest/agents/{agentLocator}
Parameters	`agentLocator: string<AgentLocator>`

Get agent matching the locator.


Endpoint	/app/rest/agents/{agentLocator}
Produces	`application/xml` `application/json`
Parameters	`agentLocator: string<AgentLocator>` `fields: string`
Response	`Agent`

Get the authorization info of the matching agent.


Endpoint	/app/rest/agents/{agentLocator}/authorizedInfo
Produces	`application/xml` `application/json`
Parameters	`agentLocator: string<AgentLocator>` `fields: string`
Response	`AuthorizedInfo`

Update the authorization info of the matching agent.


Endpoint	/app/rest/agents/{agentLocator}/authorizedInfo
Consumes	`application/xml` `application/json`
Produces	`application/xml` `application/json`
Parameters	`agentLocator: string<AgentLocator>` `body: AuthorizedInfo` `fields: string`
Response	`AuthorizedInfo`

Get the build configuration run policy of the matching agent.


Endpoint	/app/rest/agents/{agentLocator}/compatibilityPolicy
Produces	`application/xml` `application/json`
Parameters	`agentLocator: string<AgentLocator>` `fields: string`
Response	`CompatibilityPolicy`

Update build configuration run policy of agent matching locator.


Endpoint	/app/rest/agents/{agentLocator}/compatibilityPolicy
Consumes	`application/xml` `application/json`
Produces	`application/xml` `application/json`
Parameters	`agentLocator: string<AgentLocator>` `body: CompatibilityPolicy` `fields: string`
Response	`CompatibilityPolicy`

Get build types compatible with the matching agent.


Endpoint	/app/rest/agents/{agentLocator}/compatibleBuildTypes
Produces	`application/xml` `application/json`
Parameters	`agentLocator: string<AgentLocator>` `fields: string`
Response	`BuildTypes`

Check if the matching agent is enabled.


Endpoint	/app/rest/agents/{agentLocator}/enabledInfo
Produces	`application/xml` `application/json`
Parameters	`agentLocator: string<AgentLocator>` `fields: string`
Response	`EnabledInfo`

Update the enablement status of the matching agent.


Endpoint	/app/rest/agents/{agentLocator}/enabledInfo
Consumes	`application/xml` `application/json`
Produces	`application/xml` `application/json`
Parameters	`agentLocator: string<AgentLocator>` `body: EnabledInfo` `fields: string`
Response	`EnabledInfo`

Get build types incompatible with the matching agent.


Endpoint	/app/rest/agents/{agentLocator}/incompatibleBuildTypes
Produces	`application/xml` `application/json`
Parameters	`agentLocator: string<AgentLocator>` `fields: string`
Response	`Compatibilities`

Get the agent pool of the matching agent.


Endpoint	/app/rest/agents/{agentLocator}/pool
Produces	`application/xml` `application/json`
Parameters	`agentLocator: string<AgentLocator>` `fields: string`
Response	`AgentPool`

Assign the matching agent to the specified agent pool.


Endpoint	/app/rest/agents/{agentLocator}/pool
Consumes	`application/xml` `application/json`
Produces	`application/xml` `application/json`
Parameters	`agentLocator: string<AgentLocator>` `body: AgentPool` `fields: string`
Response	`AgentPool`

Get a field of the matching agent.


Endpoint	/app/rest/agents/{agentLocator}/{field}
Produces	`text/plain`
Parameters	`agentLocator: string<AgentLocator>` `field: string`
Response	`string`

Update a field of the matching agent.


Endpoint	/app/rest/agents/{agentLocator}/{field}
Consumes	`text/plain`
Produces	`text/plain`
Parameters	`agentLocator: string<AgentLocator>` `field: string` `body: string`
Response	`string`

Last modified: 30 March 2022