POST
/
api
/
v2
/
concurrency_limits
/

Headers

x-prefect-api-version
string

Body

application/json

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

active
boolean
default: true

Whether the concurrency limit is active.

name
string
required

The name of the concurrency limit.

limit
integer
required

The concurrency limit.

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.

Response

201 - application/json

An ORM representation of a v2 concurrency limit.

id
string
created
string | null
updated
string | null
active
boolean
default: true

Whether the concurrency limit is active.

name
string
required

The name of the concurrency limit.

limit
integer
required

The concurrency limit.

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.

Was this page helpful?

Decrement Concurrency Limits V1Read Concurrency Limit V2