Skip to main content
POST
/
deployments
/
bulk_delete
Bulk Delete Deployments
curl --request POST \
  --url https://api.example.com/deployments/bulk_delete \
  --header 'Content-Type: application/json' \
  --data '
{
  "deployments": {
    "operator": "and_",
    "id": {
      "any_": [
        "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      ],
      "not_any_": [
        "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      ]
    },
    "name": {
      "any_": [
        "my-deployment-1",
        "my-deployment-2"
      ],
      "like_": "marvin"
    },
    "flow_or_deployment_name": {
      "like_": "<string>"
    },
    "paused": {
      "eq_": true
    },
    "tags": {
      "operator": "and_",
      "all_": [
        "tag-1",
        "tag-2"
      ],
      "any_": [
        "tag-1",
        "tag-2"
      ],
      "is_null_": true
    },
    "work_queue_name": {
      "any_": [
        "work_queue_1",
        "work_queue_2"
      ]
    },
    "concurrency_limit": {
      "ge_": 123,
      "le_": 123,
      "is_null_": true
    }
  },
  "limit": 50
}
'
import requests

url = "https://api.example.com/deployments/bulk_delete"

payload = {
"deployments": {
"operator": "and_",
"id": {
"any_": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"],
"not_any_": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"]
},
"name": {
"any_": ["my-deployment-1", "my-deployment-2"],
"like_": "marvin"
},
"flow_or_deployment_name": { "like_": "<string>" },
"paused": { "eq_": True },
"tags": {
"operator": "and_",
"all_": ["tag-1", "tag-2"],
"any_": ["tag-1", "tag-2"],
"is_null_": True
},
"work_queue_name": { "any_": ["work_queue_1", "work_queue_2"] },
"concurrency_limit": {
"ge_": 123,
"le_": 123,
"is_null_": True
}
},
"limit": 50
}
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({
deployments: {
operator: 'and_',
id: {
any_: ['3c90c3cc-0d44-4b50-8888-8dd25736052a'],
not_any_: ['3c90c3cc-0d44-4b50-8888-8dd25736052a']
},
name: {any_: ['my-deployment-1', 'my-deployment-2'], like_: 'marvin'},
flow_or_deployment_name: {like_: '<string>'},
paused: {eq_: true},
tags: {
operator: 'and_',
all_: ['tag-1', 'tag-2'],
any_: ['tag-1', 'tag-2'],
is_null_: true
},
work_queue_name: {any_: ['work_queue_1', 'work_queue_2']},
concurrency_limit: {ge_: 123, le_: 123, is_null_: true}
},
limit: 50
})
};

fetch('https://api.example.com/deployments/bulk_delete', 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/deployments/bulk_delete",
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([
'deployments' => [
'operator' => 'and_',
'id' => [
'any_' => [
'3c90c3cc-0d44-4b50-8888-8dd25736052a'
],
'not_any_' => [
'3c90c3cc-0d44-4b50-8888-8dd25736052a'
]
],
'name' => [
'any_' => [
'my-deployment-1',
'my-deployment-2'
],
'like_' => 'marvin'
],
'flow_or_deployment_name' => [
'like_' => '<string>'
],
'paused' => [
'eq_' => true
],
'tags' => [
'operator' => 'and_',
'all_' => [
'tag-1',
'tag-2'
],
'any_' => [
'tag-1',
'tag-2'
],
'is_null_' => true
],
'work_queue_name' => [
'any_' => [
'work_queue_1',
'work_queue_2'
]
],
'concurrency_limit' => [
'ge_' => 123,
'le_' => 123,
'is_null_' => true
]
],
'limit' => 50
]),
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/deployments/bulk_delete"

payload := strings.NewReader("{\n \"deployments\": {\n \"operator\": \"and_\",\n \"id\": {\n \"any_\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"not_any_\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ]\n },\n \"name\": {\n \"any_\": [\n \"my-deployment-1\",\n \"my-deployment-2\"\n ],\n \"like_\": \"marvin\"\n },\n \"flow_or_deployment_name\": {\n \"like_\": \"<string>\"\n },\n \"paused\": {\n \"eq_\": true\n },\n \"tags\": {\n \"operator\": \"and_\",\n \"all_\": [\n \"tag-1\",\n \"tag-2\"\n ],\n \"any_\": [\n \"tag-1\",\n \"tag-2\"\n ],\n \"is_null_\": true\n },\n \"work_queue_name\": {\n \"any_\": [\n \"work_queue_1\",\n \"work_queue_2\"\n ]\n },\n \"concurrency_limit\": {\n \"ge_\": 123,\n \"le_\": 123,\n \"is_null_\": true\n }\n },\n \"limit\": 50\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/deployments/bulk_delete")
.header("Content-Type", "application/json")
.body("{\n \"deployments\": {\n \"operator\": \"and_\",\n \"id\": {\n \"any_\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"not_any_\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ]\n },\n \"name\": {\n \"any_\": [\n \"my-deployment-1\",\n \"my-deployment-2\"\n ],\n \"like_\": \"marvin\"\n },\n \"flow_or_deployment_name\": {\n \"like_\": \"<string>\"\n },\n \"paused\": {\n \"eq_\": true\n },\n \"tags\": {\n \"operator\": \"and_\",\n \"all_\": [\n \"tag-1\",\n \"tag-2\"\n ],\n \"any_\": [\n \"tag-1\",\n \"tag-2\"\n ],\n \"is_null_\": true\n },\n \"work_queue_name\": {\n \"any_\": [\n \"work_queue_1\",\n \"work_queue_2\"\n ]\n },\n \"concurrency_limit\": {\n \"ge_\": 123,\n \"le_\": 123,\n \"is_null_\": true\n }\n },\n \"limit\": 50\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.example.com/deployments/bulk_delete")

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 \"deployments\": {\n \"operator\": \"and_\",\n \"id\": {\n \"any_\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"not_any_\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ]\n },\n \"name\": {\n \"any_\": [\n \"my-deployment-1\",\n \"my-deployment-2\"\n ],\n \"like_\": \"marvin\"\n },\n \"flow_or_deployment_name\": {\n \"like_\": \"<string>\"\n },\n \"paused\": {\n \"eq_\": true\n },\n \"tags\": {\n \"operator\": \"and_\",\n \"all_\": [\n \"tag-1\",\n \"tag-2\"\n ],\n \"any_\": [\n \"tag-1\",\n \"tag-2\"\n ],\n \"is_null_\": true\n },\n \"work_queue_name\": {\n \"any_\": [\n \"work_queue_1\",\n \"work_queue_2\"\n ]\n },\n \"concurrency_limit\": {\n \"ge_\": 123,\n \"le_\": 123,\n \"is_null_\": true\n }\n },\n \"limit\": 50\n}"

response = http.request(request)
puts response.read_body
{
  "deleted": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ]
}
{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}

Headers

x-prefect-api-version
string

Body

application/json
deployments
DeploymentFilter · object | null

Filter criteria for deployments to delete

limit
integer
default:50

Maximum number of deployments to delete. Defaults to 50.

Required range: 1 <= x <= 50

Response

Successful Response

Response from bulk deployment deletion.

deleted
string<uuid>[]