Skip to content
Management API Reference

Delete a database branch

delete/v1/branches/{branch_id_or_ref}

Deletes the specified database branch. By default, deletes immediately. Use force=false to schedule deletion with 1-hour grace period (only when soft deletion is enabled).

OAuth scopes

  • environment:write

The fine-grained token must include the following permissions to access this endpoint:

  • branching_development_delete
  • or
  • branching_production_delete

Path parameters

  • branch_id_or_ref
    Required
    any of the following options

    Branch ref or deprecated branch ID

Query parameters

  • force
    Optional
    string

    If set to false, schedule deletion with 1-hour grace period (only when soft deletion is enabled).

Response codes

  • 200
  • 500

Response (200)

1
{
2
  "message": "ok"
3
}