Pools

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: POST

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 = true
  • 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.