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
}
'import requests
url = "https://api.example.com/v2/concurrency_limits/"
payload = {
"name": "<string>",
"limit": 1,
"active": True,
"active_slots": 0,
"denied_slots": 0,
"slot_decay_per_second": 0
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
limit: 1,
active: true,
active_slots: 0,
denied_slots: 0,
slot_decay_per_second: 0
})
};
fetch('https://api.example.com/v2/concurrency_limits/', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/v2/concurrency_limits/",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'limit' => 1,
'active' => true,
'active_slots' => 0,
'denied_slots' => 0,
'slot_decay_per_second' => 0
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/v2/concurrency_limits/"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"limit\": 1,\n \"active\": true,\n \"active_slots\": 0,\n \"denied_slots\": 0,\n \"slot_decay_per_second\": 0\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.example.com/v2/concurrency_limits/")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"limit\": 1,\n \"active\": true,\n \"active_slots\": 0,\n \"denied_slots\": 0,\n \"slot_decay_per_second\": 0\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/v2/concurrency_limits/")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"limit\": 1,\n \"active\": true,\n \"active_slots\": 0,\n \"denied_slots\": 0,\n \"slot_decay_per_second\": 0\n}"
response = http.request(request)
puts response.read_body{
"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
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Create Concurrency Limit V2
Create a task run concurrency limit.
For more information, see https://docs.prefect.io/v3/how-to-guides/workflows/global-concurrency-limits.
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
}
'import requests
url = "https://api.example.com/v2/concurrency_limits/"
payload = {
"name": "<string>",
"limit": 1,
"active": True,
"active_slots": 0,
"denied_slots": 0,
"slot_decay_per_second": 0
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
limit: 1,
active: true,
active_slots: 0,
denied_slots: 0,
slot_decay_per_second: 0
})
};
fetch('https://api.example.com/v2/concurrency_limits/', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/v2/concurrency_limits/",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'limit' => 1,
'active' => true,
'active_slots' => 0,
'denied_slots' => 0,
'slot_decay_per_second' => 0
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/v2/concurrency_limits/"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"limit\": 1,\n \"active\": true,\n \"active_slots\": 0,\n \"denied_slots\": 0,\n \"slot_decay_per_second\": 0\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.example.com/v2/concurrency_limits/")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"limit\": 1,\n \"active\": true,\n \"active_slots\": 0,\n \"denied_slots\": 0,\n \"slot_decay_per_second\": 0\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/v2/concurrency_limits/")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"limit\": 1,\n \"active\": true,\n \"active_slots\": 0,\n \"denied_slots\": 0,\n \"slot_decay_per_second\": 0\n}"
response = http.request(request)
puts response.read_body{
"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
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Headers
Body
Data used by the Prefect REST API to create a v2 concurrency limit.
The name of the concurrency limit.
^[^/%&><]+$The concurrency limit.
x >= 0Whether the concurrency limit is active.
The number of active slots.
x >= 0The number of denied slots.
x >= 0The decay rate for active slots when used as a rate limit.
x >= 0Response
Successful Response
An ORM representation of a v2 concurrency limit.
The name of the concurrency limit.
^[^/%&><]+$The concurrency limit.
Whether the concurrency limit is active.
The number of active slots.
The number of denied slots.
The decay rate for active slots when used as a rate limit.
The average amount of time a slot is occupied.
Was this page helpful?