required_status_checks

Overview

Name	required_status_checks
Type	Resource
Id	github.repos.required_status_checks

Fields

Name	Datatype
url	string
checks	array
contexts	array
contexts_url	string
strict	boolean

Methods

Name	Accessible by	Required Params	Description
get_status_checks_protection	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.
remove_status_check_protection	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.
update_status_check_protection	EXEC	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. Updating required status checks requires admin or owner permissions to the repository and branch protection to be enabled.