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
}
'
{
  "deleted": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ]
}

Headers

​
x-prefect-api-version
string

Body

application/json
​
deployments
DeploymentFilter · object

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>[]