latestOpenAPI 3.0.12026-08-10434791.3 KB

4eedf1838ef4

Pool

Create a pool rule

Create a rule that assigns an attempt to a pool based on conditions. A rule consists of a priority, conditions, and a pool ID. Rules are evaluated in priority order, from the lowest value to the highest value. Multiple rules cannot have the same priority. If all of a rule's conditions are met, an attempt is assigned to its pool. If none of the rules are met, an attempt is assigned to a default pool.

post/api/pool_rules

Request body

poolIdstring required

ID of the pool that this rule assigns attempts to.

priorityinteger required

Priority of the rule. Rules are evaluated in priority order, from the lowest value to the highest value. Multiple rules cannot have the same priority.

Example request

{
  "poolId": "42",
  "priority": 10
}

Response

Pool rule created

idstring required

ID of the pool rule.

poolIdstring required

ID of the pool that this rule assigns attempts to.

priorityinteger required

Priority of the rule. Rules are evaluated in priority order, from the lowest value to the highest value. Multiple rules cannot have the same priority.

Example response

{
  "id": "42",
  "poolId": "42",
  "priority": 10
}