Sign in

v50

latestOpenAPI 3.0.3MITraw.githubusercontent.com2023-11-288093493.9 MB
repos

Set team 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 in the GitHub Help documentation.

Replaces the list of teams that have push access to this branch. This removes all teams that previously had push access and grants push access to the new list of teams. Team restrictions include child teams.

put/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams

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.

Request body

string[] required

The slug values for teams

Response

Response

idinteger required
node_idstring required
namestring required
slugstring required
descriptionstring nullable required
privacystring
permissionstring required
urlstring uri required
html_urlstring uri required
members_urlstring required
repositories_urlstring uri required

Example response

[
  {
    "html_url": "https://github.com/orgs/rails/teams/core",
    "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",
      "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"
    }
  }
]