Update status check protection - GitHub v3 REST API

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.

curl --location --request PATCH 'https://api.github.com/repos///branches//protection/required_status_checks' \ --header 'Content-Type: application/json' \ --data-raw '{ "contexts": [ "continuous-integration/travis-ci" ], "strict": true }'

{ "checks": [ { "app_id": 0, "context": "continuous-integration/travis-ci" } ], "contexts": [ "continuous-integration/travis-ci" ], "contexts_url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks/contexts", "strict": true, "url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks" }

Request

Path Params

owner

string

required

The account owner of the repository. The name is not case sensitive.

repo

string

required

The name of the repository. The name is not case sensitive.

branch

string

required

The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use the GraphQL API.

Body Params application/json

checks

array [object {2}]

optional

The list of status checks to require in order to merge into this branch.

app_id

integer

optional

The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App. Pass -1 to explicitly allow any app to set the status.

context

string

required

The name of the required check

contexts

array[string]

deprecated

Deprecated: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use checks instead of contexts for more fine-grained control.

strict

boolean

optional

Require branches to be up to date before merging.

Examples

Responses

🟢200Response

application/json

Body

Status Check Policy

checks

array [object {2}]

required

app_id

integer | null

required

context

string

required

Example:

continuous-integration/travis-ci

contexts

array[string]

required

Example:

["continuous-integration/travis-ci"]

contexts_url

string <uri>

required

Example:

https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks/contexts

strict

boolean

required

Example:

true

url

string <uri>

required

Example:

https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks

🟠404404

🟠422422