Get status checks 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.

{ "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.

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