How to delete deployments?

[daridjcm]

Select Topic Area

Question

Body

Could someone help me with this question? I have a repository where there is a lot of implementation history. I would like to clean it.

[nickkipshidze]

It appears you can use GitHub CLI for that too:

gh api \
  --method DELETE \
  -H "Accept: application/vnd.github+json" \
  -H "X-GitHub-Api-Version: 2022-11-28" \
  /repos/OWNER/REPO/deployments/DEPLOYMENT_ID

Or curl:

curl -L \
  -X DELETE \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  -H "X-GitHub-Api-Version: 2022-11-28" \
  https://api.github.com/repos/OWNER/REPO/deployments/DEPLOYMENT_ID

This may help: https://docs.github.com/en/rest/deployments/deployments

[daridjcm]

Thanks, Nick.

[whoop-t]

In case others come across this like me, I wanted to clear all the deployments for a repo but deleting the env and recreating it with the same name kept them all.

The below will fetch 100 deployments at a time and then delete them with the id. Active deployments cant be deleted so you will see a message about that but you can ignore. I just ran this till I only had the active deployments left.

NOTE: this will do it for each environment

curl -L \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer TOKEN" \
  -H "X-GitHub-Api-Version: 2022-11-28" \
  https://api.github.com/repos/OWNER/REPO/deployments\?per_page\=100 | jq -r '.[].id' | xargs -P 0 -I {} curl -L \
  -X DELETE \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer TOKEN" \
  -H "X-GitHub-Api-Version: 2022-11-28" \
  https://api.github.com/repos/OWNER/REPO/deployments/\{\}

[lmartins18]

Thanks!!

[nibazshab]

thank you whoop-t.

[jelmerk]

I used this script to delete all deployments for an environment

#!/bin/bash

ENV=$1

for ID in $(gh api -X GET /repos/my-org/my-project/deployments?environment=${ENV// /%20} | jq -r ".[] | .id")
do 
  echo "Deleting deployment $ID"
  gh api -X DELETE /repos/miroapp-dev/my-org/my-project/deployments/$ID | jq '.'
done

[anthonycorletti]

I recently ran into something similar and learned that I had to mark deployments as inactive before deleting them. This script marks all deployments as inactive, and deletes all deployments, 100 at a time.

REPO="OWNER_NAME/REPO_NAME"
for ID in $(gh api --method GET "/repos/$REPO/deployments?per_page=100" | jq -r ".[] | .id")
do
    gh api -H "Accept: application/vnd.github+json" -H "X-GitHub-Api-Version: 2022-11-28" --method POST /repos/$REPO/deployments/$ID/statuses -f "state=inactive"
    gh api -H "Accept: application/vnd.github+json" -H "X-GitHub-Api-Version: 2022-11-28" --method DELETE /repos/$REPO/deployments/$ID
done

[idzm]

To avoid problems with extra "\r"

parse "https://api.github.com/repos/OWNER_NAME/REPO_NAME/deployments/22222222\r": net/url: invalid control character in URL

in the Git Bash on Windows:

REPO="OWNER_NAME/REPO_NAME"
for ID in $(gh api --method GET "repos/$REPO/deployments?per_page=100" | jq -r ".[] | .id" | tr -d "\r")
do
    gh api -H "Accept: application/vnd.github+json" -H "X-GitHub-Api-Version: 2022-11-28" --method DELETE repos/$REPO/deployments/$ID
done

[FaresKi]

Anthony, allow me to send you my love from Paris, France.
This has been frustrating me for MONTHS.

[sairaghavak]

I tried this: https://github.com/strumwolf/delete-deployment-environment/tree/v3.0.0?tab=readme-ov-file
In my case that didn't work.

@anthonycorletti Thank you. This works.

[ivnsch]

Why is this not possible quickly from the UI?

[ameaninglessname]

FYI, a clean history can't be achieved until #123659 is resolved.

[camilb]

If the deployments are still active, you first have to set them inactive.

#!/bin/bash

REPO="org/repo"
TOKEN="YOUR_TOKEN_HERE"

for deployment in $(curl -H "authorization: token $TOKEN" https://api.github.com/repos/$REPO/deployments?per_page=100 | jq -r '.[] | @base64'); do
    DEPLOYMENT_ID=$(echo "$deployment" | base64 --decode | jq -r '.id')
    echo "$DEPLOYMENT_ID"
    curl "https://api.github.com/repos/$REPO/deployments/$DEPLOYMENT_ID/statuses" \
        -X POST \
        -d '{"state":"inactive"}' \
        -H 'accept: application/vnd.github.ant-man-preview+json' \
        -H "authorization: token $TOKEN"
done
for deployment in $(curl -H "authorization: token $TOKEN" https://api.github.com/repos/$REPO/deployments | jq -r '.[] | @base64'); do
    DEPLOYMENT_ID=$(echo "$deployment" | base64 --decode | jq -r '.id')
    curl "https://api.github.com/repos/$REPO/deployments/$DEPLOYMENT_ID" \
        -X DELETE \
        -H "authorization: token $TOKEN"
done

[sekedus]

This script marks all deployments as inactive, and deletes all deployments, 100 at a time.

To avoid problems with extra "\r" in the Git Bash on Windows.

Thanks.
ㅤ

---

ㅤ
In Git Bash on Windows with an additional status check:

REPO="OWNER_NAME/REPO_NAME"

for ID in $(gh api "repos/$REPO/deployments?per_page=100" | jq -r '.[] | .id' | tr -d '\r'); do
  STATUS=$(gh api "repos/$REPO/deployments/$ID/statuses" | jq -r '.[0].state')

  echo "Deployment ID: $ID | Status: $STATUS"

  if [ "$STATUS" = "inactive" ]; then
    echo "→ Deleting inactive deployment ID: $ID"
    gh api -H "Accept: application/vnd.github+json" \
           -H "X-GitHub-Api-Version: 2022-11-28" \
           --method DELETE "repos/$REPO/deployments/$ID"
  fi
done