Get access restrictions

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](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. Lists who has access to this protected branch. **Note**: Users, apps, and teams `restrictions` are only available for organization-owned repositories.

GET/repos/{owner}/{repo}/branches/{branch}/protection/restrictions

Source: github-v3-rest.json
Revision: f5f067c1e6f6
Active snapshot: 85e53e3d0d65

Request

Path Parameters

owner string required
repo string required
branch string required: The name of the branch.

Responses

application/json Branch Restriction Policy object

Response

apps array[object]

required

items object

created_at string

optional

description string

optional

events array[string]

optional

external_url string

optional

html_url string

optional

id integer

optional

name string

optional

node_id string

optional

owner object

optional

avatar_url string

optional

description string

optional

events_url string

optional

followers_url string

optional

Example: "https://api.github.com/users/testorg-ea8ec76d71c3af4b/followers"

following_url string

optional

Example: "https://api.github.com/users/testorg-ea8ec76d71c3af4b/following{/other_user}"

gists_url string

optional

Example: "https://api.github.com/users/testorg-ea8ec76d71c3af4b/gists{/gist_id}"

gravatar_id string

optional

Example: ""

hooks_url string

optional

html_url string

optional

Example: "https://github.com/testorg-ea8ec76d71c3af4b"

id integer

optional

issues_url string

optional

members_url string

optional

node_id string

optional

organizations_url string

optional

Example: "https://api.github.com/users/testorg-ea8ec76d71c3af4b/orgs"

public_members_url string

optional

received_events_url string

optional

Example: "https://api.github.com/users/testorg-ea8ec76d71c3af4b/received_events"

repos_url string

optional

site_admin boolean

optional

Example: false

starred_url string

optional

Example: "https://api.github.com/users/testorg-ea8ec76d71c3af4b/starred{/owner}{/repo}"

subscriptions_url string

optional

Example: "https://api.github.com/users/testorg-ea8ec76d71c3af4b/subscriptions"

type string

optional

Example: "Organization"

url string

optional

permissions object

optional

contents string

optional

issues string

optional

metadata string

optional

single_file string

optional

slug string

optional

updated_at string

optional

apps_url string<uri>

required

teams array[object]

required

items object

description string

optionalnullable

html_url string

optional

id integer

optional

members_url string

optional

name string

optional

node_id string

optional

parent string

optionalnullable

permission string

optional

privacy string

optional

repositories_url string

optional

slug string

optional

url string

optional

teams_url string<uri>

required

url string<uri>

required

users array[object]

required

items object

avatar_url string

optional

events_url string

optional

followers_url string

optional

following_url string

optional

gists_url string

optional

gravatar_id string

optional

html_url string

optional

id integer

optional

node_id string

optional

organizations_url string

optional

received_events_url string

optional

repos_url string

optional

site_admin boolean

optional

starred_url string

optional

subscriptions_url string

optional

type string

optional

url string

optional

users_url string<uri>

required

Response Example: 200 application/json

{
  "apps": [
    {
      "created_at": "2017-07-08T16:18:44-04:00",
      "description": "",
      "events": [
        "push",
        "pull_request"
      ],
      "external_url": "https://example.com",
      "html_url": "https://github.com/apps/octoapp",
      "id": 1,
      "name": "Octocat App",
      "node_id": "MDExOkludGVncmF0aW9uMQ==",
      "owner": {
        "avatar_url": "https://github.com/images/error/octocat_happy.gif",
        "description": "A great organization",
        "events_url": "https://api.github.com/orgs/github/events",
        "hooks_url": "https://api.github.com/orgs/github/hooks",
        "id": 1,
        "issues_url": "https://api.github.com/orgs/github/issues",
        "login": "github",
        "members_url": "https://api.github.com/orgs/github/members{/member}",
        "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=",
        "public_members_url": "https://api.github.com/orgs/github/public_members{/member}",
        "repos_url": "https://api.github.com/orgs/github/repos",
        "url": "https://api.github.com/orgs/github"
      },
      "permissions": {
        "contents": "read",
        "issues": "write",
        "metadata": "read",
        "single_file": "write"
      },
      "slug": "octoapp",
      "updated_at": "2017-07-08T16:18:44-04:00"
    }
  ],
  "apps_url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/restrictions/teams",
  "teams": [
    {
      "description": "A great team.",
      "html_url": "https://github.com/orgs/github/teams/justice-league",
      "id": 1,
      "members_url": "https://api.github.com/teams/1/members{/member}",
      "name": "Justice League",
      "node_id": "MDQ6VGVhbTE=",
      "parent": null,
      "permission": "admin",
      "privacy": "closed",
      "repositories_url": "https://api.github.com/teams/1/repos",
      "slug": "justice-league",
      "url": "https://api.github.com/teams/1"
    }
  ],
  "teams_url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/restrictions/teams",
  "url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/restrictions",
  "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,
      "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": 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"
    }
  ],
  "users_url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/restrictions/users"
}

application/json Basic Error object

Resource not found

documentation_url string

optional

message string

optional

status string

optional

url string

optional

Request configuration

This OpenAPI document does not declare an authentication scheme. Check the API provider's documentation before sending credentials; Manja cannot infer or validate an undocumented scheme.

Common bearer example: Authorization: Bearer YOUR_ACCESS_TOKEN

hostname

Self-hosted Enterprise Server or Enterprise Cloud hostname

protocol

Self-hosted Enterprise Server or Enterprise Cloud protocol

owner *

repo *

branch *

The name of the branch.

Request Sample: Shell / cURL

curl --request GET \
  --url {protocol}://{hostname}/api/v3/repos/{owner}/{repo}/branches/{branch}/protection/restrictions