Update branch protection

PUT

/repos/{owner}/{repo}/branches/{branch}/protection

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.

Protecting a branch requires admin or owner permissions to the repository.

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

Note: The list of users, apps, and teams in total is limited to 100 items.

リクエストパラメータ

パスパラメータ

リクエストボディパラメータapplication/json

例

レスポンス

🟢200OK

application/json

Response

ボディapplication/json

🟠403Forbidden

🟠404Record Not Found

🟠422Parameter Error

リクエストExample

Shell

JavaScript

Java

Swift

curl --location --request PUT 'https://service1.exmaple.com/repos///branches//protection' \
--header 'Content-Type: application/json' \
--data '{
    "required_status_checks": {
        "strict": true,
        "contexts": [
            "continuous-integration/travis-ci"
        ]
    },
    "enforce_admins": true,
    "required_pull_request_reviews": {
        "dismissal_restrictions": {
            "users": [
                "octocat"
            ],
            "teams": [
                "justice-league"
            ]
        },
        "dismiss_stale_reviews": true,
        "require_code_owner_reviews": true,
        "required_approving_review_count": 2,
        "require_last_push_approval": true,
        "bypass_pull_request_allowances": {
            "users": [
                "octocat"
            ],
            "teams": [
                "justice-league"
            ]
        }
    },
    "restrictions": {
        "users": [
            "octocat"
        ],
        "teams": [
            "justice-league"
        ],
        "apps": [
            "super-ci"
        ]
    },
    "required_linear_history": true,
    "allow_force_pushes": true,
    "allow_deletions": true,
    "block_creations": true,
    "required_conversation_resolution": true,
    "lock_branch": true,
    "allow_fork_syncing": true
}'

レスポンスExample

200 - default

{
    "url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection",
    "required_status_checks": {
        "url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/required_status_checks",
        "strict": true,
        "contexts": [
            "continuous-integration/travis-ci"
        ],
        "contexts_url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/required_status_checks/contexts",
        "checks": [
            {
                "context": "continuous-integration/travis-ci",
                "app_id": null
            }
        ]
    },
    "restrictions": {
        "url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/restrictions",
        "users_url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/restrictions/users",
        "teams_url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/restrictions/teams",
        "apps_url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/restrictions/apps",
        "users": [],
        "teams": [],
        "apps": []
    },
    "required_pull_request_reviews": {
        "url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/required_pull_request_reviews",
        "dismiss_stale_reviews": true,
        "require_code_owner_reviews": true,
        "required_approving_review_count": 2,
        "require_last_push_approval": true,
        "dismissal_restrictions": {
            "url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/dismissal_restrictions",
            "users_url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/dismissal_restrictions/users",
            "teams_url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/dismissal_restrictions/teams",
            "users": [],
            "teams": [],
            "apps": []
        }
    },
    "required_signatures": {
        "url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/required_signatures",
        "enabled": false
    },
    "enforce_admins": {
        "url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/enforce_admins",
        "enabled": true
    },
    "required_linear_history": {
        "enabled": true
    },
    "allow_force_pushes": {
        "enabled": true
    },
    "allow_deletions": {
        "enabled": true
    },
    "block_creations": {
        "enabled": true
    },
    "required_conversation_resolution": {
        "enabled": true
    },
    "lock_branch": {
        "enabled": true
    },
    "allow_fork_syncing": {
        "enabled": true
    }
}

更新日時 2025-06-12 06:47:19

Get branch protection

Delete branch protection