branch_restrictions

Overview

Name	branch_restrictions
Type	Resource
Id	github.repos.branch_restrictions

Fields

Name	Datatype
apps	array
apps_url	string
teams	array
teams_url	string
url	string
users	array
users_url	string

Methods

Name	Accessible by	Required Params	Description
get_access_restrictions	SELECT	branch, owner, repo	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. Lists who has access to this protected branch. Note: Users, apps, and teams restrictions are only available for organization-owned repositories.
delete_access_restrictions	DELETE	branch, owner, repo	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. Disables the ability to restrict who can push to this branch.