Pools

REST Overview
Jobs	Job Reports	Groups	Pools	Limits	Repository	Pulse	Workers	Tasks	Task Reports	Users

Overview

Pool requests can be used to set and retrieve information for one or many Pools.

Pool requests support GET, PUT, POST, and DELETE request types.

For more about these request types and their uses see the Request Formats and Responses documentation.

Requests and Responses

List of possible requests for Pools

Get Pool Names

Gets Pool Names.

URL:	http://hostname:portnumber/api/pools
Request Type:	GET
Message Body:	N/A
Response:	JSON object containing all the Pool names.
Possible Errors:	500 Internal Server Error: An exception occurred within the Deadline code.

Get Workers For Pools

Gets all the Worker names for the provided Pool names.

URL:	http://hostname:portnumber/api/pools?Pool=oneOrMorePoolNames
Request Type:	GET
Message Body:	N/A
Response:	JSON object containing all Worker names that are in the provided Pools.
Possible Errors:	500 Internal Server Error: An exception occurred within the Deadline code.

Add Pools

Creates new Pools using the provided Pool names.

URL:	http://hostname:portnumber/api/pools
Request Type:	POST
Message Body:	JSON object that must contain the following keys: Pool = Pool name(s) (may be an Array)
Response:	“Success”
Possible Errors:	500 Internal Server Error: An exception occurred within the Deadline code.

Set Pools

Removes all Pools not provided and creates any provided Pools that did not exist.

URL:	http://hostname:portnumber/api/pools
Request Type:	PUT
Message Body:	JSON object that must contain the following keys: Pool = Pool name(s) (may be an Array) OverWrite = true
Response:	“Success”
Possible Errors:	500 Internal Server Error: An exception occurred within the Deadline code.

Add Pools to Workers

Adds the provided Pools to the assigned Pools for each provided Worker. For both Pools and Workers, only the names are required.

URL:	http://hostname:portnumber/api/pools
Request Type:	PUT
Message Body:	JSON object that must contain the following keys: Slave = Worker name(s) (may be an Array) Pool = Pool name(s) (may be an Array)
Response:	“Success”
Possible Errors:	500 Internal Server Error: An exception occurred within the Deadline code.

Set Pools for Workers

Sets provided Pools as the assigned Pools for each provided Worker. For both Pools and Workers, only the names are required.

URL:	http://hostname:portnumber/api/pools
Request Type:	PUT
Message Body:	JSON object that must contain the following keys: Slave = Worker name(s) (may be an Array) Pool = Pool name(s) (may be an Array) OverWrite = true
Response:	“Success”
Possible Errors:	500 Internal Server Error: An exception occurred within the Deadline code.

Purge Pools

Purges all obsolete Pools using the provided replacement Pool.

URL:	http://hostname:portnumber/api/pools
Request Type:	PUT
Message Body:	JSON object that must contain the following keys: OverWrite = false ReplacementPool = Pool name to replace the Pools being purged
Response:	“Success”
Possible Errors:	500 Internal Server Error: An exception occurred within the Deadline code, or Replacement Pool name provided does not exist.

Set and Purge Pools

Sets the list of Pools to the provided list of Pool names, creating them if necessary. Purges all the obsolete Pools using the provided replacement Pool.

URL:	http://hostname:portnumber/api/pools
Request Type:	PUT
Message Body:	JSON object that must contain the following keys: OverWrite = true ReplacementPool = Pool name to replace the Pools being purged Pool = the Pool(s) provided for setting, the replacement Pool must be in this Pool list or must be “none” (may be an Array)
Response:	“Success”
Possible Errors:	500 Internal Server Error: An exception occurred within the Deadline code, or Replacement Pool name provided does not exist.

Add and Purge Pools

Adds the list of provided Pools, creating them if necessary. Purges all the obsolete Pools using the provided replacement Pool.

URL:	http://hostname:portnumber/api/pools
Request Type:	PUT
Message Body:	JSON object that must contain the following keys: ReplacementPool = Pool name to replace the Pools being purged Pool = the Pool(s) provided for adding (may be an Array)
Response:	“Success”
Possible Errors:	500 Internal Server Error: An exception occurred within the Deadline code, or Replacement Pool name provided does not exist.

Delete Pools

Deletes all Pools with the provided Pool names.

URL:	http://hostname:portnumber/api/pools?Pool=oneOrMorePoolNames
Request Type:	DELETE
Message Body:	N/A
Response:	“Success”
Possible Errors:	500 Internal Server Error: An exception occurred within the Deadline code.

Delete Pools From Workers

Deletes all Pools from the Worker’s list of Pools.

URL:	http://hostname:portnumber/api/pools?Pool=oneOrMorePoolNames&Slaves=oneOrMoreSlaveNames
Request Type:	DELETE
Message Body:	N/A
Response:	“Success”
Possible Errors:	500 Internal Server Error: An exception occurred within the Deadline code.