Update branch protection
PUT
/repos/{owner}/{repo}/branches/{branch}/protection
repos
users and teams replaces their previous values.Request Request Example
Shell
JavaScript
Java
Swift
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,
"allow_fork_syncing": true,
"block_creations": true,
"enforce_admins": true,
"lock_branch": true,
"required_conversation_resolution": true,
"required_linear_history": true,
"required_pull_request_reviews": {
"bypass_pull_request_allowances": {
"teams": [
"justice-league"
],
"users": [
"octocat"
]
},
"dismiss_stale_reviews": true,
"dismissal_restrictions": {
"teams": [
"justice-league"
],
"users": [
"octocat"
]
},
"require_code_owner_reviews": true,
"require_last_push_approval": 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"
]
}
}'Response Response Example
200 - Example 1
{
"allow_deletions": {
"enabled": true
},
"allow_force_pushes": {
"enabled": true
},
"allow_fork_syncing": {
"enabled": false
},
"block_creations": {
"enabled": true
},
"enforce_admins": {
"enabled": true,
"url": "http://example.com"
},
"lock_branch": {
"enabled": false
},
"required_conversation_resolution": {
"enabled": true
},
"required_linear_history": {
"enabled": true
},
"required_pull_request_reviews": {
"bypass_pull_request_allowances": {
"apps": [
{
"client_id": "\"Iv1.25b5d1e65ffc4022\"",
"client_secret": "\"1d4b2097ac622ba702d19de498f005747a8b21d3\"",
"created_at": "2017-07-08T20:18:44.000Z",
"description": "The description of the app.",
"events": [
"label",
"deployment"
],
"external_url": "https://example.com",
"html_url": "https://github.com/apps/super-ci",
"id": 37,
"installations_count": 5,
"name": "Probot Owners",
"node_id": "MDExOkludGVncmF0aW9uMQ==",
"owner": {
"avatar_url": "https://github.com/images/error/octocat_happy.gif",
"email": "string",
"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",
"name": "string",
"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"
},
"pem": "\"-----BEGIN RSA PRIVATE KEY-----\\nMIIEogIBAAKCAQEArYxrNYD/iT5CZVpRJu4rBKmmze3PVmT/gCo2ATUvDvZTPTey\\nxcGJ3vvrJXazKk06pN05TN29o98jrYz4cengG3YGsXPNEpKsIrEl8NhbnxapEnM9\\nJCMRe0P5JcPsfZlX6hmiT7136GRWiGOUba2X9+HKh8QJVLG5rM007TBER9/z9mWm\\nrJuNh+m5l320oBQY/Qq3A7wzdEfZw8qm/mIN0FCeoXH1L6B8xXWaAYBwhTEh6SSn\\nZHlO1Xu1JWDmAvBCi0RO5aRSKM8q9QEkvvHP4yweAtK3N8+aAbZ7ovaDhyGz8r6r\\nzhU1b8Uo0Z2ysf503WqzQgIajr7Fry7/kUwpgQIDAQABAoIBADwJp80Ko1xHPZDy\\nfcCKBDfIuPvkmSW6KumbsLMaQv1aGdHDwwTGv3t0ixSay8CGlxMRtRDyZPib6SvQ\\n6OH/lpfpbMdW2ErkksgtoIKBVrDilfrcAvrNZu7NxRNbhCSvN8q0s4ICecjbbVQh\\nnueSdlA6vGXbW58BHMq68uRbHkP+k+mM9U0mDJ1HMch67wlg5GbayVRt63H7R2+r\\nVxcna7B80J/lCEjIYZznawgiTvp3MSanTglqAYi+m1EcSsP14bJIB9vgaxS79kTu\\noiSo93leJbBvuGo8QEiUqTwMw4tDksmkLsoqNKQ1q9P7LZ9DGcujtPy4EZsamSJT\\ny8OJt0ECgYEA2lxOxJsQk2kI325JgKFjo92mQeUObIvPfSNWUIZQDTjniOI6Gv63\\nGLWVFrZcvQBWjMEQraJA9xjPbblV8PtfO87MiJGLWCHFxmPz2dzoedN+2Coxom8m\\nV95CLz8QUShuao6u/RYcvUaZEoYs5bHcTmy5sBK80JyEmafJPtCQVxMCgYEAy3ar\\nZr3yv4xRPEPMat4rseswmuMooSaK3SKub19WFI5IAtB/e7qR1Rj9JhOGcZz+OQrl\\nT78O2OFYlgOIkJPvRMrPpK5V9lslc7tz1FSh3BZMRGq5jSyD7ETSOQ0c8T2O/s7v\\nbeEPbVbDe4mwvM24XByH0GnWveVxaDl51ABD65sCgYB3ZAspUkOA5egVCh8kNpnd\\nSd6SnuQBE3ySRlT2WEnCwP9Ph6oPgn+oAfiPX4xbRqkL8q/k0BdHQ4h+zNwhk7+h\\nWtPYRAP1Xxnc/F+jGjb+DVaIaKGU18MWPg7f+FI6nampl3Q0KvfxwX0GdNhtio8T\\nTj1E+SnFwh56SRQuxSh2gwKBgHKjlIO5NtNSflsUYFM+hyQiPiqnHzddfhSG+/3o\\nm5nNaSmczJesUYreH5San7/YEy2UxAugvP7aSY2MxB+iGsiJ9WD2kZzTUlDZJ7RV\\nUzWsoqBR+eZfVJ2FUWWvy8TpSG6trh4dFxImNtKejCR1TREpSiTV3Zb1dmahK9GV\\nrK9NAoGAbBxRLoC01xfxCTgt5BDiBcFVh4fp5yYKwavJPLzHSpuDOrrI9jDn1oKN\\nonq5sDU1i391zfQvdrbX4Ova48BN+B7p63FocP/MK5tyyBoT8zQEk2+vWDOw7H/Z\\nu5dTCPxTIsoIwUw1I+7yIxqJzLPFgR2gVBwY1ra/8iAqCj+zeBw=\\n-----END RSA PRIVATE KEY-----\\n\"",
"permissions": {
"deployments": "write",
"issues": "read"
},
"slug": "probot-owners",
"updated_at": "2017-07-08T20:18:44.000Z",
"webhook_secret": "\"6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b\""
}
],
"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",
"permissions": {
"admin": true,
"maintain": true,
"pull": true,
"push": true,
"triage": true
},
"privacy": "string",
"repositories_url": "http://example.com",
"slug": "string",
"url": "http://example.com"
}
],
"users": [
{
"avatar_url": "https://github.com/images/error/octocat_happy.gif",
"email": "string",
"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",
"name": "string",
"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"
}
]
},
"dismiss_stale_reviews": true,
"dismissal_restrictions": {
"apps": [
{
"client_id": "\"Iv1.25b5d1e65ffc4022\"",
"client_secret": "\"1d4b2097ac622ba702d19de498f005747a8b21d3\"",
"created_at": "2017-07-08T20:18:44.000Z",
"description": "The description of the app.",
"events": [
"label",
"deployment"
],
"external_url": "https://example.com",
"html_url": "https://github.com/apps/super-ci",
"id": 37,
"installations_count": 5,
"name": "Probot Owners",
"node_id": "MDExOkludGVncmF0aW9uMQ==",
"owner": {
"avatar_url": "https://github.com/images/error/octocat_happy.gif",
"email": "string",
"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",
"name": "string",
"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"
},
"pem": "\"-----BEGIN RSA PRIVATE KEY-----\\nMIIEogIBAAKCAQEArYxrNYD/iT5CZVpRJu4rBKmmze3PVmT/gCo2ATUvDvZTPTey\\nxcGJ3vvrJXazKk06pN05TN29o98jrYz4cengG3YGsXPNEpKsIrEl8NhbnxapEnM9\\nJCMRe0P5JcPsfZlX6hmiT7136GRWiGOUba2X9+HKh8QJVLG5rM007TBER9/z9mWm\\nrJuNh+m5l320oBQY/Qq3A7wzdEfZw8qm/mIN0FCeoXH1L6B8xXWaAYBwhTEh6SSn\\nZHlO1Xu1JWDmAvBCi0RO5aRSKM8q9QEkvvHP4yweAtK3N8+aAbZ7ovaDhyGz8r6r\\nzhU1b8Uo0Z2ysf503WqzQgIajr7Fry7/kUwpgQIDAQABAoIBADwJp80Ko1xHPZDy\\nfcCKBDfIuPvkmSW6KumbsLMaQv1aGdHDwwTGv3t0ixSay8CGlxMRtRDyZPib6SvQ\\n6OH/lpfpbMdW2ErkksgtoIKBVrDilfrcAvrNZu7NxRNbhCSvN8q0s4ICecjbbVQh\\nnueSdlA6vGXbW58BHMq68uRbHkP+k+mM9U0mDJ1HMch67wlg5GbayVRt63H7R2+r\\nVxcna7B80J/lCEjIYZznawgiTvp3MSanTglqAYi+m1EcSsP14bJIB9vgaxS79kTu\\noiSo93leJbBvuGo8QEiUqTwMw4tDksmkLsoqNKQ1q9P7LZ9DGcujtPy4EZsamSJT\\ny8OJt0ECgYEA2lxOxJsQk2kI325JgKFjo92mQeUObIvPfSNWUIZQDTjniOI6Gv63\\nGLWVFrZcvQBWjMEQraJA9xjPbblV8PtfO87MiJGLWCHFxmPz2dzoedN+2Coxom8m\\nV95CLz8QUShuao6u/RYcvUaZEoYs5bHcTmy5sBK80JyEmafJPtCQVxMCgYEAy3ar\\nZr3yv4xRPEPMat4rseswmuMooSaK3SKub19WFI5IAtB/e7qR1Rj9JhOGcZz+OQrl\\nT78O2OFYlgOIkJPvRMrPpK5V9lslc7tz1FSh3BZMRGq5jSyD7ETSOQ0c8T2O/s7v\\nbeEPbVbDe4mwvM24XByH0GnWveVxaDl51ABD65sCgYB3ZAspUkOA5egVCh8kNpnd\\nSd6SnuQBE3ySRlT2WEnCwP9Ph6oPgn+oAfiPX4xbRqkL8q/k0BdHQ4h+zNwhk7+h\\nWtPYRAP1Xxnc/F+jGjb+DVaIaKGU18MWPg7f+FI6nampl3Q0KvfxwX0GdNhtio8T\\nTj1E+SnFwh56SRQuxSh2gwKBgHKjlIO5NtNSflsUYFM+hyQiPiqnHzddfhSG+/3o\\nm5nNaSmczJesUYreH5San7/YEy2UxAugvP7aSY2MxB+iGsiJ9WD2kZzTUlDZJ7RV\\nUzWsoqBR+eZfVJ2FUWWvy8TpSG6trh4dFxImNtKejCR1TREpSiTV3Zb1dmahK9GV\\nrK9NAoGAbBxRLoC01xfxCTgt5BDiBcFVh4fp5yYKwavJPLzHSpuDOrrI9jDn1oKN\\nonq5sDU1i391zfQvdrbX4Ova48BN+B7p63FocP/MK5tyyBoT8zQEk2+vWDOw7H/Z\\nu5dTCPxTIsoIwUw1I+7yIxqJzLPFgR2gVBwY1ra/8iAqCj+zeBw=\\n-----END RSA PRIVATE KEY-----\\n\"",
"permissions": {
"deployments": "write",
"issues": "read"
},
"slug": "probot-owners",
"updated_at": "2017-07-08T20:18:44.000Z",
"webhook_secret": "\"6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b\""
}
],
"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",
"permissions": {
"admin": true,
"maintain": true,
"pull": true,
"push": true,
"triage": true
},
"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",
"email": "string",
"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",
"name": "string",
"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,
"require_last_push_approval": false,
"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": {
"checks": [
{
"app_id": 0,
"context": "continuous-integration/travis-ci"
}
],
"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",
"site_admin": false,
"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"
}Request
Path Params
owner
stringÂ
required
repo
stringÂ
required
branch
stringÂ
required
Body Params application/json
Responses
Modified at 2023-08-15 02:59:29