refs/.
The repository’s default branch cannot be deleted. This protection only applies to non-ephemeral
branches — an ephemeral branch that shares the same short name as the default branch can still be
deleted.
Options
string
required
Branch name to delete (e.g.
feature/old-onboarding). Must not start with refs/.boolean
Delete from the ephemeral namespace instead of the persistent one (default:
false). Use this to
clean up branches created with ephemeral: true.object[]
Ordered per-ref policy rules (
{ pattern, ops? }) embedded in the per-call JWT. First match wins. Python: ref_policies. Go: RefPolicies with type storage.RefPolicyList. See the Branch Protection guide.Response
string
The deleted branch name.
boolean
Whether the deleted branch was in the ephemeral namespace.
string
Confirmation message from the API.