Delete a branch

Authorization

A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:

Service Token Accesses delete_branch

OAuth Scopes

Resource	Scopes
Organization	delete_branches, delete_production_branches
Database	delete_branches, delete_production_branches
Branch	delete_branch

DELETE /organizations/{organization}/databases/{database}/branches/{branch}

Delete a branch

cURL

curl --request DELETE \
  --url https://api.planetscale.com/v1/organizations/{organization}/databases/{database}/branches/{branch} \
  --header 'Authorization: Bearer <token>'

Authorizations

Authorization · string · header · required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

organization · string · required

The name of the organization the branch belongs to

database · string · required

The name of the database the branch belongs to

branch · string · required

The name of the branch

Query Parameters

delete_descendants · boolean

If true, recursively delete all descendant branches along with this branch

Response

204

Delete a branch