Skip to main content
Version: QB15

Interact with Build Agents

Get list of active build agents​

Syntax​

List of active build agents can be fetched by issuing GET request to below url:

http://localhost:8810/rest/buildagents/active

The response is of mime type text/plain and the content is XML representation of list of active build agents.

Security​

Only user with permission VIEW GRID PAGE can access list of active build agents.

Demo​

Below curl command demonstrates how to get list of active build agents:

curl http://localhost:8810/rest/buildagents/active

Get list of inactive build agents​

Syntax​

List of inactive build agents can be fetched by issuing GET request to below url:

http://localhost:8810/rest/buildagents/inactive

The response is of mime type text/plain and the content is XML representation of list of inactive build agents.

Security​

Only user with permission VIEW GRID PAGE can access list of active build agents.

Demo​

Below curl command demonstrates how to get list of active build agents:

curl http://localhost:8810/rest/buildagents/inactive

Get list of unauthorized build agents​

Syntax​

List of unauthorized build agents can be fetched by issuing GET request to below url:

http://localhost:8810/rest/buildagents/unauthorized

The response is of mime type text/plain and the content is XML representation of list of unauthorized build agents.

Security​

Only user with permission VIEW GRID PAGE can access list of active build agents.

Demo​

Below curl command demonstrates how to get list of unauthorized build agents:

curl http://localhost:8810/rest/buildagents/unauthorized

Get list of running steps on specified build agent (since 5.1.24)​

Syntax​

List of running steps can be fetched by issuing GET request to below url:

http://localhost:8810/rest/buildagents/<node address>/running_steps

The response is of mime type text/plain and the content is XML representation of list of running steps.

Security​

Only user with permission VIEW GRID PAGE can access list of active build agents.

Demo​

Below curl command demonstrates how to get list of running steps on agent "myagent:8811":

curl "http://localhost:8810/rest/buildagents/myagent:8811/running_steps"