Get a branch-protection rule

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

getBranchProtection

Returns the protection rule keyed on exactly this branch pattern. 404 when no rule with that pattern exists.

Authentication optional — this operation also accepts anonymous requests. When authenticating, use a bearer token or a session cookie.

curl

curl -X GET 'https://neosource.dev/api/repos/OWNER/REPO/branches/BRANCH/protection' \
  -H 'Authorization: Bearer $NEOSOURCE_TOKEN'

fetch

fetch("https://neosource.dev/api/repos/OWNER/REPO/branches/BRANCH/protection", {
  method: "GET",
  headers: {
    Authorization: "Bearer $NEOSOURCE_TOKEN",
  },
});

Path parameters

ownerrequired: Repository owner or organization slug.
string
reporequired: Repository name.
string
branchrequired: Exact branch name or glob pattern the rule is keyed on (`*` matches within one `/`-segment, `**` crosses segments). Names containing `/` must be percent-encoded (`release%2Fv1`).
string
ownerrequired: string
reporequired: string
branchrequired: string

Responses

200Protection rule

application/json

BranchProtectionResponse

object

allow_deletionsrequired: boolean
Permit deleting a branch this rule covers. `false` blocks.
allow_force_pushesrequired: boolean
Permit a non-fast-forward update to a branch this rule covers. `false` blocks — see `BranchProtectionRequest::allow_force_pushes`.
branch_patternrequired: string
The pattern the rule is keyed on (exact branch name or glob).
created_atrequired: integerint64
enforce_adminsrequired: boolean
repo_idrequired: string
require_any_checkrequired: boolean
Require *some* check to have run and passed on the head, without naming it. See `BranchProtectionRequest::require_any_check`.
require_conversation_resolutionrequired: boolean
require_pull_requestrequired: boolean
Refuse every direct update (fast-forward included); changes must arrive via a PR. `true` blocks — see `BranchProtectionRequest::require_pull_request`.
required_approving_reviewsrequired: integerint32
required_status_checksrequired: array
items
string
strict_up_to_daterequired: boolean
updated_atrequired: integerint64

Standard errors

Bodies documented once for the whole API — see standard errors.

400Bad Request — one of: invalid_input
403Forbidden — one of: forbidden
404Not Found — one of: not_found
423Locked — one of: busy
429Rate limited — retry after the `Retry-After` header
500Internal server error
503Service temporarily unavailable / at capacity — retry after the `Retry-After` header
504Gateway timeout — the request exceeded the server's handling budget