Branch¶

Branches isolate development and release lines. With the API you can list, create, and delete branches, read a single branch, and manage protected branch rules (which branches forbid force pushes and deletion, and who may push to them).

Objects¶

Identification¶

• Repositories are identified by owner + repo, branches by the path parameter name or branch.
• Protection rules are identified by wildcard, which can be written as a wildcard pattern matching a set of branches.

Common tasks¶

Notes¶

• Creating a protection rule uses the fixed literal new: PUT …/branches/setting/new, not branches/{wildcard}/setting. Only updating and deleting use {wildcard}.
• The protection rule list endpoint is GET …/protect_branches (underscore), which is not the same path family as the branch list …/branches.
• Deleting a branch uses {name} while reading a single branch uses {branch}. The two placeholder names differ but mean the same thing, so be careful when copying paths.
• Branch-related permissions (push rules, permission modes) live in the repositories group; this group only covers branches themselves and protection rules.

Endpoint list¶

This module contains 8 endpoints in total.