repository
Create a branch protections for a repository
post/repos/{owner}/{repo}/branch_protections
Path parameters
ownerstring required
owner of the repo
repostring required
name of the repo
Request body
approvals_whitelist_teamsstring[]
approvals_whitelist_usernamestring[]
block_admin_merge_overrideboolean
block_on_codeowner_reviewsboolean
block_on_official_review_requestsboolean
block_on_outdated_branchboolean
block_on_rejected_reviewsboolean
branch_namestring
bypass_allowlist_teamsstring[]
bypass_allowlist_usernamesstring[]
dismiss_stale_approvalsboolean
enable_approvals_whitelistboolean
enable_bypass_allowlistboolean
enable_force_pushboolean
enable_force_push_allowlistboolean
enable_merge_whitelistboolean
enable_pushboolean
enable_push_whitelistboolean
enable_status_checkboolean
force_push_allowlist_deploy_keysboolean
force_push_allowlist_teamsstring[]
force_push_allowlist_usernamesstring[]
ignore_stale_approvalsboolean
merge_whitelist_teamsstring[]
merge_whitelist_usernamesstring[]
priorityinteger
protected_file_patternsstring
push_whitelist_deploy_keysboolean
push_whitelist_teamsstring[]
push_whitelist_usernamesstring[]
require_signed_commitsboolean
required_approvalsinteger
rule_namestring
status_check_contextsstring[]
unprotected_file_patternsstring
Response
BranchProtection
approvals_whitelist_teamsstring[]
approvals_whitelist_usernamestring[]
block_admin_merge_overrideboolean
block_on_codeowner_reviewsboolean
block_on_official_review_requestsboolean
block_on_outdated_branchboolean
block_on_rejected_reviewsboolean
branch_namestring
bypass_allowlist_teamsstring[]
bypass_allowlist_usernamesstring[]
created_atstring date-time
dismiss_stale_approvalsboolean
enable_approvals_whitelistboolean
enable_bypass_allowlistboolean
enable_force_pushboolean
enable_force_push_allowlistboolean
enable_merge_whitelistboolean
enable_pushboolean
enable_push_whitelistboolean
enable_status_checkboolean
force_push_allowlist_deploy_keysboolean
force_push_allowlist_teamsstring[]
force_push_allowlist_usernamesstring[]
ignore_stale_approvalsboolean
merge_whitelist_teamsstring[]
merge_whitelist_usernamesstring[]
priorityinteger
Priority is the priority of this branch protection rule
protected_file_patternsstring
push_whitelist_deploy_keysboolean
push_whitelist_teamsstring[]
push_whitelist_usernamesstring[]
require_signed_commitsboolean
required_approvalsinteger
rule_namestring
RuleName is the name of the branch protection rule
status_check_contextsstring[]
unprotected_file_patternsstring
updated_atstring date-time