How to delete a Bamboo plan by API

[sarah-cit]

There's a way to delete a plan by API?
I've looked at https://docs.atlassian.com/atlassian-bamboo/REST/5.13.2/#d2e2421 but I couldn't find a method that deletes an specific plan.

[Jeremy Owen]

Hey Sarah,

Unfortunately there's no REST API to delete a plan at this time.

As an alternative, you could utilize an internal Bamboo API to perform the removal but that's subject to change (and has changed in the past) between versions without much notice. So it's risky to rely on this endpoint being static.

There's an example on how you can do that for Bamboo 6.6 posted by my colleague as an answer to the below question:

• https://community.atlassian.com/t5/Bamboo-questions/Bamboo-REST-API-to-delete-plans/qaq-p/899665

However I noticed that you were looking at the Bamboo 5.13.2 REST API documentation and the above example won't work on Bamboo 5.13.2.

I've adapted the example for Bamboo 5.13.2 and included it below:

#
# Marks plan for deletion. Plan will be deleted by batch job.
#
# replace {username}
# replace {planKey}, e.g PROJ-PLAN
# replace http://localhost:8085 with URL to access Bamboo

curl -k -u {username} \
 -H 'X-Atlassian-Token: no-check' \
 -H 'Accept: application/json' \
 -H 'Content-Type: application/x-www-form-urlencoded' \
 -d 'buildKey={planKey}' \
 -X POST 'http://localhost:8085/chain/admin/deleteChain!doDelete.action'

Hope this helps! :)

Cheers,

Jeremy