Skip to main content
POST
/
v2
/
concurrency_limits
Create Concurrency Limit V2
curl --request POST \
  --url https://api.example.com/v2/concurrency_limits/ \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "limit": 1,
  "active": true,
  "active_slots": 0,
  "denied_slots": 0,
  "slot_decay_per_second": 0
}
'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "created": "2023-11-07T05:31:56Z",
  "updated": "2023-11-07T05:31:56Z",
  "name": "<string>",
  "limit": 123,
  "active": true,
  "active_slots": 0,
  "denied_slots": 0,
  "slot_decay_per_second": 0,
  "avg_slot_occupancy_seconds": 2
}

Headers

​
x-prefect-api-version
string

Body

application/json

Data used by the Prefect REST API to create a v2 concurrency limit.

​
name
string
required

The name of the concurrency limit.

Pattern: ^[^/%&><]+$
​
limit
integer
required

The concurrency limit.

Required range: x >= 0
​
active
boolean
default:true

Whether the concurrency limit is active.

​
active_slots
integer
default:0

The number of active slots.

Required range: x >= 0
​
denied_slots
integer
default:0

The number of denied slots.

Required range: x >= 0
​
slot_decay_per_second
number
default:0

The decay rate for active slots when used as a rate limit.

Required range: x >= 0

Response

Successful Response

An ORM representation of a v2 concurrency limit.

​
id
string<uuid>
required
​
created
string<date-time> | null
required
​
updated
string<date-time> | null
required
​
name
string
required

The name of the concurrency limit.

Pattern: ^[^/%&><]+$
​
limit
integer
required

The concurrency limit.

​
active
boolean
default:true

Whether the concurrency limit is active.

​
active_slots
integer
default:0

The number of active slots.

​
denied_slots
integer
default:0

The number of denied slots.

​
slot_decay_per_second
number
default:0

The decay rate for active slots when used as a rate limit.

​
avg_slot_occupancy_seconds
number
default:2

The average amount of time a slot is occupied.