v17

latestOpenAPI 3.0.1raw.githubusercontent.com2026-07-08165682.0 MB
Database branches

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

ResourceScopes
Organizationdelete_branches, delete_production_branches
Databasedelete_branches, delete_production_branches
Branchdelete_branch
delete/organizations/{organization}/databases/{database}/branches/{branch}

Path parameters

organizationstring required

The name of the organization the branch belongs to

databasestring required

The name of the database the branch belongs to

branchstring required

The name of the branch

Query parameters

delete_descendantsboolean

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

Response

Delete a branch