repos
Get 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.
get/repos/{owner}/{repo}/branches/{branch}/protection
Path parameters
ownerstring required
The account owner of the repository. The name is not case sensitive.
repostring required
The name of the repository without the .git extension. The name is not case sensitive.
branchstring required
The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use the GraphQL API.
Response
Response
Example response
{
"enforce_admins": {
"url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/enforce_admins",
"enabled": true
},
"required_pull_request_reviews": {
"url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/dismissal_restrictions",
"dismissal_restrictions": {
"users": [
{
"login": "octocat",
"id": 1,
"node_id": "MDQ6VXNlcjE=",
"avatar_url": "https://github.com/images/error/octocat_happy.gif",
"gravatar_id": "41d064eb2195891e12d0413f63227ea7",
"url": "https://api.github.com/users/octocat",
"html_url": "https://github.com/octocat",
"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}",
"starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
"subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
"organizations_url": "https://api.github.com/users/octocat/orgs",
"repos_url": "https://api.github.com/users/octocat/repos",
"events_url": "https://api.github.com/users/octocat/events{/privacy}",
"received_events_url": "https://api.github.com/users/octocat/received_events",
"type": "User",
"starred_at": "\"2020-07-09T00:17:55Z\"",
"user_view_type": "public"
}
],
"teams": [
{
"html_url": "https://github.com/orgs/rails/teams/core",
"access_source": "direct",
"organization_id": 37,
"enterprise_id": 42,
"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",
"privacy": "closed",
"notification_setting": "notifications_enabled",
"html_url": "https://github.com/orgs/rails/teams/core",
"repositories_url": "https://api.github.com/organizations/1/team/1/repos",
"slug": "justice-league",
"ldap_dn": "uid=example,ou=users,dc=github,dc=com",
"organization_id": 37,
"enterprise_id": 42
}
}
],
"apps": [
{
"id": 37,
"slug": "probot-owners",
"node_id": "MDExOkludGVncmF0aW9uMQ==",
"client_id": "\"Iv1.25b5d1e65ffc4022\"",
"owner": {
"login": "octocat",
"id": 1,
"node_id": "MDQ6VXNlcjE=",
"avatar_url": "https://github.com/images/error/octocat_happy.gif",
"gravatar_id": "41d064eb2195891e12d0413f63227ea7",
"url": "https://api.github.com/users/octocat",
"html_url": "https://github.com/octocat",
"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}",
"starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
"subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
"organizations_url": "https://api.github.com/users/octocat/orgs",
"repos_url": "https://api.github.com/users/octocat/repos",
"events_url": "https://api.github.com/users/octocat/events{/privacy}",
"received_events_url": "https://api.github.com/users/octocat/received_events",
"type": "User",
"starred_at": "\"2020-07-09T00:17:55Z\"",
"user_view_type": "public"
},
"name": "Probot Owners",
"description": "The description of the app.",
"external_url": "https://example.com",
"html_url": "https://github.com/apps/super-ci",
"created_at": "2017-07-08T16:18:44-04:00",
"updated_at": "2017-07-08T16:18:44-04:00",
"permissions": {
"issues": "read",
"deployments": "write"
},
"events": [
"label",
"deployment"
],
"installations_count": 5
}
],
"url": "\"https://api.github.com/repos/the-org/an-org-repo/branches/master/protection/dismissal_restrictions\"",
"users_url": "\"https://api.github.com/repos/the-org/an-org-repo/branches/master/protection/dismissal_restrictions/users\"",
"teams_url": "\"https://api.github.com/repos/the-org/an-org-repo/branches/master/protection/dismissal_restrictions/teams\""
},
"bypass_pull_request_allowances": {
"users": [
{
"login": "octocat",
"id": 1,
"node_id": "MDQ6VXNlcjE=",
"avatar_url": "https://github.com/images/error/octocat_happy.gif",
"gravatar_id": "41d064eb2195891e12d0413f63227ea7",
"url": "https://api.github.com/users/octocat",
"html_url": "https://github.com/octocat",
"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}",
"starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
"subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
"organizations_url": "https://api.github.com/users/octocat/orgs",
"repos_url": "https://api.github.com/users/octocat/repos",
"events_url": "https://api.github.com/users/octocat/events{/privacy}",
"received_events_url": "https://api.github.com/users/octocat/received_events",
"type": "User",
"starred_at": "\"2020-07-09T00:17:55Z\"",
"user_view_type": "public"
}
],
"teams": [
{
"html_url": "https://github.com/orgs/rails/teams/core",
"access_source": "direct",
"organization_id": 37,
"enterprise_id": 42,
"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",
"privacy": "closed",
"notification_setting": "notifications_enabled",
"html_url": "https://github.com/orgs/rails/teams/core",
"repositories_url": "https://api.github.com/organizations/1/team/1/repos",
"slug": "justice-league",
"ldap_dn": "uid=example,ou=users,dc=github,dc=com",
"organization_id": 37,
"enterprise_id": 42
}
}
],
"apps": [
{
"id": 37,
"slug": "probot-owners",
"node_id": "MDExOkludGVncmF0aW9uMQ==",
"client_id": "\"Iv1.25b5d1e65ffc4022\"",
"owner": {
"login": "octocat",
"id": 1,
"node_id": "MDQ6VXNlcjE=",
"avatar_url": "https://github.com/images/error/octocat_happy.gif",
"gravatar_id": "41d064eb2195891e12d0413f63227ea7",
"url": "https://api.github.com/users/octocat",
"html_url": "https://github.com/octocat",
"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}",
"starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
"subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
"organizations_url": "https://api.github.com/users/octocat/orgs",
"repos_url": "https://api.github.com/users/octocat/repos",
"events_url": "https://api.github.com/users/octocat/events{/privacy}",
"received_events_url": "https://api.github.com/users/octocat/received_events",
"type": "User",
"starred_at": "\"2020-07-09T00:17:55Z\"",
"user_view_type": "public"
},
"name": "Probot Owners",
"description": "The description of the app.",
"external_url": "https://example.com",
"html_url": "https://github.com/apps/super-ci",
"created_at": "2017-07-08T16:18:44-04:00",
"updated_at": "2017-07-08T16:18:44-04:00",
"permissions": {
"issues": "read",
"deployments": "write"
},
"events": [
"label",
"deployment"
],
"installations_count": 5
}
]
},
"dismiss_stale_reviews": true,
"require_code_owner_reviews": true,
"required_approving_review_count": 2,
"require_last_push_approval": true
},
"restrictions": {
"teams": [
{
"html_url": "https://github.com/orgs/rails/teams/core",
"access_source": "direct",
"organization_id": 37,
"enterprise_id": 42,
"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",
"privacy": "closed",
"notification_setting": "notifications_enabled",
"html_url": "https://github.com/orgs/rails/teams/core",
"repositories_url": "https://api.github.com/organizations/1/team/1/repos",
"slug": "justice-league",
"ldap_dn": "uid=example,ou=users,dc=github,dc=com",
"organization_id": 37,
"enterprise_id": 42
}
}
],
"apps": [
{
"owner": {
"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\"",
"user_view_type": "public"
}
}
]
},
"name": "\"branch/with/protection\"",
"protection_url": "\"https://api.github.com/repos/owner-79e94e2d36b3fd06a32bb213/AAA_Public_Repo/branches/branch/with/protection/protection\"",
"required_signatures": {
"url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_signatures",
"enabled": true
}
}