repository

Retrieve a specific branch from a repository, including its effective branch protection

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

Request

Base URL
https://demo.gitea.com/api/v1
Auth
- HTTP basic
- or API key in query parameter token
- or API key in query parameter access_token
- or API key in header Authorization
- or API key in query parameter sudo
- or API key in header Sudo
- or API key in header X-GITEA-OTP
TypeScript
https://skmtc.dev/gitea/apis/gitea-api/docs/repos/:owner/:repo/branches/:branch/get.ts
A function with typed inputs. Its response is checked against the schema.

ownerstring required

owner of the repo

repostring required

name of the repo

branchstring required

branch to get

Branch

effective_branch_protection_namestring

EffectiveBranchProtectionName is the name of the effective branch protection rule

enable_status_checkboolean

EnableStatusCheck indicates if status checks are enabled

namestring

Name is the branch name

protectedboolean

Protected indicates if the branch is protected

required_approvalsinteger

RequiredApprovals is the number of required approvals for pull requests

status_check_contextsstring[]

StatusCheckContexts contains the list of required status check contexts

user_can_mergeboolean

UserCanMerge indicates if the current user can merge to this branch

user_can_pushboolean

UserCanPush indicates if the current user can push to this branch

Oct 28, 20267ef50c4c527f Revision changes
- info
  removed the non-success response with the status