Skip to main content

pr_review_protection

Overview

Namepr_review_protection
TypeResource
Idgithub.repos.pr_review_protection

Fields

NameDatatypeDescription
bypass_pull_request_allowancesobjectAllow specific users, teams, or apps to bypass pull request requirements.
dismiss_stale_reviewsboolean
dismissal_restrictionsobject
require_code_owner_reviewsboolean
require_last_push_approvalbooleanWhether the most recent push must be approved by someone other than the person who pushed it.
required_approving_review_countinteger
urlstring

Methods

NameAccessible byRequired ParamsDescription
get_pull_request_review_protectionSELECTbranch, owner, repoProtected 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.
delete_pull_request_review_protectionDELETEbranch, owner, repoProtected 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_pull_request_review_protectionEXECbranch, owner, repoProtected 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 pull request review enforcement requires admin or owner permissions to the repository and branch protection to be enabled.

Note: Passing new arrays of users and teams replaces their previous values.