分支

Enterprise Cloud

Enterprise Server

Enterprise Server 3.6

Enterprise Server 3.7

Enterprise Server 3.8

Enterprise Server 3.9

Free, Pro, & Team

GitHub AE

REST API

所有 GitHub 文档都是开源的。 看到错误或不清楚的内容了吗？ 提交拉取请求。

帮助我们创建出色的文档！

在 GitHub 旅程中随时为你提供帮助。

可以是以下选项之一

名称

所有 {{ name }} 指南

{{ name }} 学习路径

操作

输入搜索词以在 GitHub 文档中找到它。

分支 - GitHub 文档

使用 REST API 修改分支及其保护设置。

English

Simplified Chinese

Spanish

Portuguese

Russian

Japanese

French

German

Korean

快速入门

关于 GitHub 的 API

REST API 中的资源

API 版本

媒体类型

身份验证

确保 API 凭据安全

故障排除

OpenAPI 描述

适用于 GitHub Apps 安装令牌的终结点

适用于 GitHub Apps 用户令牌的终结点

细化 PAT 的终结点

GitHub 应用的权限

细化 PAT 的权限

重大更改

概述

使用 API

使用 JavaScript 编写脚本

为用户发现资源

交付部署

将数据渲染为图形

处理注释

分页

构建 CI 服务器

集成者最佳做法

入门 - Git 数据库

开始 - 检查

Guides

Artifacts

缓存

OIDC

权限

机密

自托管运行程序

变量

工作流程作业

工作流运行

工作流

事件

通知

标星

关注中

活动

GitHub 应用

安装

市场

OAuth 授权

Webhook

应用

计费

受保护的分支

检查运行

检查套件

检查

行为准则

Codes of conduct

代码扫描

Codespaces

组织

组织机密

存储库机密

用户机密

协作者

邀请

提交

提交注释

提交状态

Copilot for Business

Copilot

警报

Dependabot

依赖项检查

依赖项提交

软件材料清单 (SBOM)

依赖项关系图

部署密钥

部署分支策略

部署

环境

保护规则

部署状态

表情符号

Gists

注释

Blob

reference

标记

Trees

Git 数据库

Gitignore

存储库

用户

交互

问题

受理人

里程碑

时间线

许可证

Markdown

元数据

社区

统计信息

交通

指标

源导入

迁移

阻止用户

成员

外部协作者

个人访问令牌

规则

安全经理

Boards

卡片

Projects (classic)

拉取

评价注释

审查请求

审阅

速率限制

反应

发行版本

发布资产

自动链接

前叉

Git LFS

搜索

机密扫描

存储库安全公告

安全通知

Teams

讨论评论

讨论

电子邮件

关注者

GPG 密钥

Git SSH 密钥

SSH 签名密钥

社交帐户

存储库 Webhook 配置

存储库 Webhook 交付

存储库 Webhook

仓库 web 挂钩

master

Short Branch

The account owner of the repository. The name is not case sensitive.

owner

The name of the repository without the <code>.git</code> extension. The name is not case sensitive.

repo

Setting to <code>true</code> returns only protected branches. When set to <code>false</code>, only unprotected branches are returned. Omitting this parameter returns all branches.

protected

The number of results per page (max 100).

per_page

Page number of the results to fetch.

page

List branches

main

Commit

Branch Protection

Branch With Protection

The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use <a href="https://docs.github.com/graphql">the GraphQL API</a>.

branch

Get a branch

new_name

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. For more information, see "<a href="https://docs.github.com/github/administering-a-repository/renaming-a-branch">Renaming a branch</a>".
The permissions required to use this endpoint depends on whether you are renaming the default branch.
To rename a non-default branch:
<ul>
<li>Users must have push access.</li>
<li>GitHub Apps must have the <code>contents:write</code> repository permission.</li>
</ul>
To rename the default branch:
<ul>
<li>Users must have admin or owner permissions.</li>
<li>GitHub Apps must have the <code>administration:write</code> repository permission.</li>
</ul>

Validation failed, or the endpoint has been spammed.

Rename a branch

The name of the branch which should be updated to match upstream.

The branch has been successfully synced with the upstream repository

Sync a branch of a forked repository to keep it up-to-date with the upstream repository.

Sync a fork branch with the upstream repository