Skip to content
API Documents/Treasure Workflow API/
/
Delete a pool

Delete a pool

Request

Delete a pool. You cannot delete a pool if there are any attempts running or queued in the pool, if a pool rule references it, or if it is the default pool. The deleted pool’s concurrency limit is added to the default pool’s concurrency limit.

Security
ApiKeyAuth
Path
poolIdinteger, (int32)required

ID of the pool.

curl -i -X DELETE \
  'https://api-workflow.treasuredata.com/api/pools/{poolId}' \
  -H 'Authorization: TD1 <YOUR_TOKEN_HERE>'

Responses

Pool deleted

Bodyapplication/json
concurrencyLimitinteger, (int32), >= 1required

Maximum number of concurrent attempts that can run in this pool. Total concurrency limit of all pools cannot exceed the account's concurrency limit.

Example:10
defaultbooleanrequired

Whether the pool is the default pool.

Example:true
idstring, >= 1required

ID of the pool.

Example:"42"
namestring, [ 1 .. 256 ] charactersrequired

Name of the pool. This name must be unique within the account.

Example:"activation"
Response
{
  "concurrencyLimit": 10,
  "default": true,
  "id": "42",
  "name": "activation"
}