Update branch protection
PUT {{baseUrl}}/repos/:owner/:repo/branches/: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.
Request Body
{"required_status_checks"=>{"strict"=>"<boolean>", "contexts"=>["<string>", "<string>"]}, "enforce_admins"=>"<boolean>", "required_pull_request_reviews"=>{"dismissal_restrictions"=>{"users"=>["<string>", "<string>"], "teams"=>["<string>", "<string>"]}, "dismiss_stale_reviews"=>"<boolean>", "require_code_owner_reviews"=>"<boolean>", "required_approving_review_count"=>"<integer>"}, "restrictions"=>{"users"=>["<string>", "<string>"], "teams"=>["<string>", "<string>"], "apps"=>["<string>", "<string>"]}, "required_linear_history"=>"<boolean>", "allow_force_pushes"=>"<boolean>", "allow_deletions"=>"<boolean>"}
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Content-Type | string |
RESPONSES
status: OK
{"url":"sed ","required_status_checks":{"url":"https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks","contexts_url":"https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks/contexts","strict":true,"contexts":["continuous-integration/travis-ci"]},"required_pull_request_reviews":{"url":"pr","dismiss_stale_reviews":false,"require_code_owner_reviews":true,"required_approving_review_count":-59148144,"dismissal_restrictions":{"url":"irure cupidatat incididunt ut non","users_url":"nulla voluptate esse reprehenderit","teams_url":"irure amet do","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":"","html_url":"https://github.com/octocat","id":1,"node_id":"MDQ6VXNlcjE=","login":"octocat","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":false,"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","starred_at":"\"2020-07-09T00:17:55Z\""},{"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":"","html_url":"https://github.com/octocat","id":1,"node_id":"MDQ6VXNlcjE=","login":"octocat","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":false,"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","starred_at":"\"2020-07-09T00:17:55Z\""}],"teams":[{"id":-20758783,"node_id":"velit irure","url":"eiusmod","members_url":"exercitation cupidatat dolor","name":"do quis","description":"commodo veniam dolor sed","permission":"sit dolor","html_url":"https://github.com/orgs/rails/teams/core","repositories_url":"aliquip quis","slug":"consectetur dolor sed officia nulla","privacy":"amet dolore dolor","parent":{"id":1,"node_id":"MDQ6VGVhbTE=","url":"https://api.github.com/organizations/1/team/1","members_url":"https://api.github.com/organizations/1/team/1/members{/member}","name":"Justice League","description":"A great team.","permission":"admin","html_url":"https://github.com/orgs/rails/teams/core","repositories_url":"https://api.github.com/organizations/1/team/1/repos","slug":"justice-league","privacy":"closed","ldap_dn":"uid=example,ou=users,dc=github,dc=com"}},{"id":-28442548,"node_id":"minim ullamco esse","url":"ea qui","members_url":"adipisicing sint consectetur","name":"ipsum","description":"ad quis","permission":"pariatur adipisicing id ut","html_url":"https://github.com/orgs/rails/teams/core","repositories_url":"fugiat","slug":"incididunt dolor irure velit","privacy":"aliquip fugiat sunt Duis","parent":{"id":1,"node_id":"MDQ6VGVhbTE=","url":"https://api.github.com/organizations/1/team/1","members_url":"https://api.github.com/organizations/1/team/1/members{/member}","name":"Justice League","description":"A great team.","permission":"admin","html_url":"https://github.com/orgs/rails/teams/core","repositories_url":"https://api.github.com/organizations/1/team/1/repos","slug":"justice-league","privacy":"closed","ldap_dn":"uid=example,ou=users,dc=github,dc=com"}}]}},"required_signatures":{"url":"https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_signatures","enabled":true},"enforce_admins":{"url":"ullamco dolor do cillum","enabled":false},"required_linear_history":{"enabled":true},"allow_force_pushes":{"enabled":true},"allow_deletions":{"enabled":false},"restrictions":{"url":"anim","users_url":"deserunt amet officia","teams_url":"commodo velit aute","apps_url":"ex ","users":[{"login":"cillum","id":7182443,"node_id":"do","avatar_url":"et anim Duis","gravatar_id":"do id nisi","url":"Excepteur","html_url":"nostrud Excepteur ut tempor","followers_url":"dolore aliqua ut","following_url":"eiusmod Excepteur ullamco","gists_url":"ullamco enim","starred_url":"cupidatat commodo ex","subscriptions_url":"commodo id dolore sunt culpa","organizations_url":"do dolore ad","repos_url":"eu elit","events_url":"in elit id irure laborum","received_events_url":"in sunt","type":"exercitation eiu","site_admin":true},{"login":"eiusmod culpa consectetur nostrud","id":-34555638,"node_id":"ad id","avatar_url":"exercitation non","gravatar_id":"ut","url":"veniam eiusmod","html_url":"laboris dolor ad","followers_url":"proident sint eu amet","following_url":"pariatur quis aliquip","gists_url":"veniam","starred_url":"commodo exercitation ullamco","subscriptions_url":"id","organizations_url":"minim","repos_url":"ex laborum proident labore","events_url":"commodo deserunt proident","received_events_url":"ea proident labore","type":"do dolor non Duis voluptate","site_admin":false}],"teams":[{"id":-28356371,"node_id":"cillum ipsum ex aliquip deserunt","url":"Lorem in aute et","html_url":"irure ex sit dolor","name":"consectetur Ut","slug":"eiusmod proident nisi","description":"ut sit","privacy":"irure nostrud","permission":"anim non nostrud irure","members_url":"veniam Lorem voluptate","repositories_url":"id sint","parent":"fugiat"},{"id":44904358,"node_id":"sint ea","url":"ea in cupidatat","html_url":"Ut cillum aute","name":"occaecat sed veniam","slug":"est ea","description":"dolore aute","privacy":"mollit nisi id","permission":"fugiat nisi laboris dolore","members_url":"ad sed","repositories_url":"laboris commodo enim sunt","parent":"Duis aliquip esse ut commodo"}],"apps":[{"id":-81364986,"slug":"in consequat","node_id":"irure est reprehenderit","owner":{"login":"ex aute","id":-9192535,"node_id":"dolore ut qui consequat nulla","url":"velit null","repos_url":"veniam do","events_url":"nulla quis cillum cupidatat","hooks_url":"est mollit","issues_url":"sunt aliquip ea ut","members_url":"cillum commodo incididunt ullamco","public_members_url":"tempor","avatar_url":"fugiat ex","description":"adipisicing dolo","gravatar_id":"\"\"","html_url":"\"https://github.com/testorg-ea8ec76d71c3af4b\"","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}\"","starred_url":"\"https://api.github.com/users/testorg-ea8ec76d71c3af4b/starred{/owner}{/repo}\"","subscriptions_url":"\"https://api.github.com/users/testorg-ea8ec76d71c3af4b/subscriptions\"","organizations_url":"\"https://api.github.com/users/testorg-ea8ec76d71c3af4b/orgs\"","received_events_url":"\"https://api.github.com/users/testorg-ea8ec76d71c3af4b/received_events\"","type":"\"Organization\""},"name":"est in ut do","description":"laborum in ea","external_url":"est","html_url":"in nostrud voluptate","created_at":"laboris","updated_at":"proident","permissions":{"metadata":"aliqua amet","contents":"minim Lorem in","issues":"consequat nostrud","single_file":"exercitation incididunt"},"events":["elit culpa sint eiusmod eu","do"]},{"id":77404762,"slug":"i","node_id":"sint velit elit","owner":{"login":"anim in laboris Lorem","id":-90108251,"node_id":"Ut adipisicing aute dolor","url":"nisi esse pr","repos_url":"reprehenderit ut","events_url":"in fugiat Duis proident ullamco","hooks_url":"quis ut aliqua","issues_url":"Lorem dolore","members_url":"quis ex cupidatat tempor","public_members_url":"ad Excep","avatar_url":"sunt enim ex qui","description":"sint","gravatar_id":"\"\"","html_url":"\"https://github.com/testorg-ea8ec76d71c3af4b\"","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}\"","starred_url":"\"https://api.github.com/users/testorg-ea8ec76d71c3af4b/starred{/owner}{/repo}\"","subscriptions_url":"\"https://api.github.com/users/testorg-ea8ec76d71c3af4b/subscriptions\"","organizations_url":"\"https://api.github.com/users/testorg-ea8ec76d71c3af4b/orgs\"","received_events_url":"\"https://api.github.com/users/testorg-ea8ec76d71c3af4b/received_events\"","type":"\"Organization\""},"name":"Excepteur commodo adipisicing laboris minim","description":"cupidatat enim","external_url":"aute sint enim","html_url":"enim sit","created_at":"eu dolor","updated_at":"laboris","permissions":{"metadata":"incididunt labore anim veniam nos","contents":"quis ipsum Ut","issues":"minim aute in","single_file":"ad ut enim commodo sint"},"events":["ad sunt incididunt","officia anim commodo veniam"]}]}}