latestOpenAPI 3.0.12026-08-10434791.3 KB

4eedf1838ef4

Pool

Create a pool

Create a pool with the specified name and concurrency limit. A default pool is created with the account's concurrency limit if it does not exist. The default pool’s concurrency limit is reduced by the new pool’s concurrency limit. You cannot create a pool if the default pool has more running attempts than its new reduced concurrency limit.

post/api/pools

Request body

concurrencyLimitinteger required

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

namestring required

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

Example request

{
  "concurrencyLimit": 10,
  "name": "activation"
}

Response

Pool created

concurrencyLimitinteger required

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

defaultboolean required

Whether the pool is the default pool.

idstring required

ID of the pool.

namestring required

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

Example response

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