Rename a branch
Renames a branch in a repository.
Note: Although the API responds immediately, the branch rename process might take some extra time to complete in the background. You won't be able to push to the old branch name while the rename process is in progress.
The permissions required to use this endpoint depends on whether you are renaming the default branch.
To rename a non-default branch:
- Users must have push access.
- Apps must have the
contents:writerepository permission.
To rename the default branch:
- Users must have admin or owner permissions.
- Apps must have the
administration:writerepository permission.
Header Parameters
Authorizationstring
Acceptstring
Response
200
Object
Response Attributes
namestring
commitobject
Show child attributes
_linksobject
Show child attributes
protectedboolean
protectionobject
Show child attributes
protection_urlstring
Was this section helpful?
What made this section unhelpful for you?
Response
Was this section helpful?
What made this section unhelpful for you?