Update branch protection

Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.

Protecting a branch requires admin or owner permissions to the repository.

Note: Passing new arrays of users and teams replaces their previous values.

Note: The list of users, apps, and teams in total is limited to 100 items.

curl --location --request PUT 'https://api.github.com/repos///branches//protection' \ --header 'Content-Type: application/json' \ --data-raw '{ "allow_deletions": true, "allow_force_pushes": true, "enforce_admins": true, "required_linear_history": true, "required_pull_request_reviews": { "dismiss_stale_reviews": true, "dismissal_restrictions": { "teams": [ "justice-league" ], "users": [ "octocat" ] }, "require_code_owner_reviews": true, "required_approving_review_count": 2 }, "required_status_checks": { "contexts": [ "continuous-integration/travis-ci" ], "strict": true }, "restrictions": { "apps": [ "super-ci" ], "teams": [ "justice-league" ], "users": [ "octocat" ] } }'

{ "allow_deletions": { "enabled": true }, "allow_force_pushes": { "enabled": true }, "enforce_admins": { "enabled": true, "url": "http://example.com" }, "required_conversation_resolution": { "enabled": true }, "required_linear_history": { "enabled": true }, "required_pull_request_reviews": { "dismiss_stale_reviews": true, "dismissal_restrictions": { "teams": [ { "description": "string", "html_url": "https://github.com/orgs/rails/teams/core", "id": 0, "members_url": "string", "name": "string", "node_id": "string", "parent": { "description": "A great team.", "html_url": "https://github.com/orgs/rails/teams/core", "id": 1, "ldap_dn": "uid=example,ou=users,dc=github,dc=com", "members_url": "https://api.github.com/organizations/1/team/1/members{/member}", "name": "Justice League", "node_id": "MDQ6VGVhbTE=", "permission": "admin", "privacy": "closed", "repositories_url": "https://api.github.com/organizations/1/team/1/repos", "slug": "justice-league", "url": "https://api.github.com/organizations/1/team/1" }, "permission": "string", "privacy": "string", "repositories_url": "http://example.com", "slug": "string", "url": "http://example.com" } ], "teams_url": "http://example.com", "url": "http://example.com", "users": [ { "avatar_url": "https://github.com/images/error/octocat_happy.gif", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "gravatar_id": "41d064eb2195891e12d0413f63227ea7", "html_url": "https://github.com/octocat", "id": 1, "login": "octocat", "node_id": "MDQ6VXNlcjE=", "organizations_url": "https://api.github.com/users/octocat/orgs", "received_events_url": "https://api.github.com/users/octocat/received_events", "repos_url": "https://api.github.com/users/octocat/repos", "site_admin": true, "starred_at": "\"2020-07-09T00:17:55Z\"", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "type": "User", "url": "https://api.github.com/users/octocat" } ], "users_url": "http://example.com" }, "require_code_owner_reviews": true, "required_approving_review_count": 0, "url": "http://example.com" }, "required_signatures": { "enabled": true, "url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_signatures" }, "required_status_checks": { "contexts": [ "continuous-integration/travis-ci" ], "contexts_url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks/contexts", "strict": true, "url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks" }, "restrictions": { "apps": [ { "created_at": "string", "description": "string", "events": [ "string" ], "external_url": "string", "html_url": "string", "id": 0, "name": "string", "node_id": "string", "owner": { "avatar_url": "string", "description": "string", "events_url": "string", "followers_url": "\"https://api.github.com/users/testorg-ea8ec76d71c3af4b/followers\"", "following_url": "\"https://api.github.com/users/testorg-ea8ec76d71c3af4b/following{/other_user}\"", "gists_url": "\"https://api.github.com/users/testorg-ea8ec76d71c3af4b/gists{/gist_id}\"", "gravatar_id": "\"\"", "hooks_url": "string", "html_url": "\"https://github.com/testorg-ea8ec76d71c3af4b\"", "id": 0, "issues_url": "string", "login": "string", "members_url": "string", "node_id": "string", "organizations_url": "\"https://api.github.com/users/testorg-ea8ec76d71c3af4b/orgs\"", "public_members_url": "string", "received_events_url": "\"https://api.github.com/users/testorg-ea8ec76d71c3af4b/received_events\"", "repos_url": "string", "starred_url": "\"https://api.github.com/users/testorg-ea8ec76d71c3af4b/starred{/owner}{/repo}\"", "subscriptions_url": "\"https://api.github.com/users/testorg-ea8ec76d71c3af4b/subscriptions\"", "type": "\"Organization\"", "url": "string" }, "permissions": { "contents": "string", "issues": "string", "metadata": "string", "single_file": "string" }, "slug": "string", "updated_at": "string" } ], "apps_url": "http://example.com", "teams": [ { "description": "string", "html_url": "string", "id": 0, "members_url": "string", "name": "string", "node_id": "string", "parent": "string", "permission": "string", "privacy": "string", "repositories_url": "string", "slug": "string", "url": "string" } ], "teams_url": "http://example.com", "url": "http://example.com", "users": [ { "avatar_url": "string", "events_url": "string", "followers_url": "string", "following_url": "string", "gists_url": "string", "gravatar_id": "string", "html_url": "string", "id": 0, "login": "string", "node_id": "string", "organizations_url": "string", "received_events_url": "string", "repos_url": "string", "site_admin": true, "starred_url": "string", "subscriptions_url": "string", "type": "string", "url": "string" } ], "users_url": "http://example.com" }, "url": "http://example.com" }

请求参数

Authorization

在 Header 添加参数

Authorization

，其值为在 Bearer 之后拼接 Token

示例：

Authorization: Bearer ********************

Path 参数

owner

string

必需

repo

string

必需

branch

string

必需

The name of the branch.

Body 参数application/json

allow_deletions

boolean

可选

Allows deletion of the protected branch by anyone with write access to the repository. Set to false to prevent deletion of the protected branch. Default: false. For more information, see "Enabling force pushes to a protected branch" in the GitHub Help documentation.

allow_force_pushes

boolean | null

可选

Permits force pushes to the protected branch by anyone with write access to the repository. Set to true to allow force pushes. Set to false or null to block force pushes. Default: false. For more information, see "Enabling force pushes to a protected branch" in the GitHub Help documentation."

enforce_admins

boolean | null

必需

Enforce all configured restrictions for administrators. Set to true to enforce required status checks for repository administrators. Set to null to disable.

required_linear_history

boolean

可选

Enforces a linear commit Git history, which prevents anyone from pushing merge commits to a branch. Set to true to enforce a linear commit history. Set to false to disable a linear commit Git history. Your repository must allow squash merging or rebase merging before you can enable a linear commit history. Default: false. For more information, see "Requiring a linear commit history" in the GitHub Help documentation.

required_pull_request_reviews

object | null

必需

Require at least one approving review on a pull request, before merging. Set to null to disable.

dismiss_stale_reviews

boolean

可选

Set to true if you want to automatically dismiss approving reviews when someone pushes a new commit.

dismissal_restrictions

object

可选

Specify which users and teams can dismiss pull request reviews. Pass an empty dismissal_restrictions object to disable. User and team dismissal_restrictions are only available for organization-owned repositories. Omit this parameter for personal repositories.

require_code_owner_reviews

boolean

可选

Blocks merging pull requests until code owners review them.

required_approving_review_count

integer

可选

Specify the number of reviewers required to approve pull requests. Use a number between 1 and 6.

required_status_checks

object | null

必需

Require status checks to pass before merging. Set to null to disable.

contexts

array[string]

必需

The list of status checks to require in order to merge into this branch

strict

boolean

必需

Require branches to be up to date before merging.

restrictions

object | null

必需

Restrict who can push to the protected branch. User, app, and team restrictions are only available for organization-owned repositories. Set to null to disable.

apps

array[string]

可选

The list of app slugs with push access

teams

array[string]

必需

The list of team slugs with push access

users

array[string]

必需

The list of user logins with push access

示例

返回响应

🟢200Response

application/json

Body

Branch protections protect branches

allow_deletions

object

可选

enabled

boolean

必需

allow_force_pushes

object

可选

enabled

boolean

必需

enforce_admins

object

可选

enabled

boolean

必需

url

string <uri>

必需

required_conversation_resolution

object

可选

enabled

boolean

可选

required_linear_history

object

可选

enabled

boolean

必需

required_pull_request_reviews

object

可选

dismiss_stale_reviews

boolean

可选

dismissal_restrictions

object

可选

require_code_owner_reviews

boolean

可选

required_approving_review_count

integer

可选

url

string <uri>

必需

required_signatures

object

可选

enabled

boolean

必需

示例值:

true

url

string <uri>

必需

示例值:

https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_signatures

required_status_checks

object (Status Check Policy)

可选

Status Check Policy

contexts

array[string]

必需

示例值:

["continuous-integration/travis-ci"]

contexts_url

string <uri>

必需

示例值:

https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks/contexts

strict

boolean

必需

示例值:

true

url

string <uri>

必需

示例值:

https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks

restrictions

object (Branch Restriction Policy)

可选

Branch Restriction Policy

apps

array [object {12}]

必需

apps_url

string <uri>

必需

teams

array [object {12}]

必需

teams_url

string <uri>

必需

url

string <uri>

必需

users

array [object {18}]

必需

users_url

string <uri>

必需

url

string <uri>

必需

🟠403403

🟠404404

🟠415415

🟠422422