Interact with Build Agents

Version 1 by Robin Shen
on Feb 01, 2021 07:53.

compared with

Current by Robin Shen
on Dec 27, 2021 14:17.

Key

These lines were removed. This word was removed.

These lines were added. This word was added.

View page history

There are 4 changes. View first change.

		h1. Get list of active build agents

		h2. Syntax
		List of active build agents can be fetched by issuing GET request to below url:
		{code}http://localhost:8810/rest/buildagents/active{code}

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

		h2. Security
		Any user can access list of active build agents.
		Only user with permission _VIEW GRID PAGE_ can access list of active build agents.

		h2. Demo
		Below [curl\|http://curl.haxx.se/] command demonstrates how to get list of active build agents:
		{code}curl http://localhost:8810/rest/buildagents/active{code}

		h1. Get list of inactive build agents

		h2. Syntax
		List of inactive build agents can be fetched by issuing GET request to below url:
		{code}http://localhost:8810/rest/buildagents/inactive{code}
		The response is of mime type _text/plain_ and the content is XML representation of list of inactive build agents.

		h2. Security
		Any user can access list of inactive build agents.
		Only user with permission _VIEW GRID PAGE_ can access list of active build agents.

		h2. Demo
		Below [curl\|http://curl.haxx.se/] command demonstrates how to get list of active build agents:
		{code}curl http://localhost:8810/rest/buildagents/inactive{code}

		h1. Get list of unauthorized build agents

		h2. Syntax
		List of unauthorized build agents can be fetched by issuing GET request to below url:
		{code}http://localhost:8810/rest/buildagents/unauthorized{code}

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

		h2. Security
		Any user can access list of unauthorized build agents.
		Only user with permission _VIEW GRID PAGE_ can access list of active build agents.

		h2. Demo
		Below [curl\|http://curl.haxx.se/] command demonstrates how to get list of unauthorized build agents:
		{code}curl http://localhost:8810/rest/buildagents/unauthorized{code}

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

		h2. Syntax
		List of running steps can be fetched by issuing GET request to below url:
		{code}http://localhost:8810/rest/buildagents/<node address>/running_steps{code}

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

		h2. Security
		Any user can access list of running steps of specified agent.
		Only user with permission _VIEW GRID PAGE_ can access list of active build agents.

		h2. Demo
		Below [curl\|http://curl.haxx.se/] command demonstrates how to get list of running steps on agent "myagent:8811":
		{code}curl "http://localhost:8810/rest/buildagents/myagent:8811/running_steps"{code}