Update a branch reference to a new commit

PUT

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

curl --request PUT \
  --url https://gitea.example.com/api/v1/repos/example/example/branches/example \
  --header 'Authorization: Basic <credentials>' \
  --header 'Content-Type: application/json' \
  --data '{ "force": true, "new_commit_id": "example", "old_commit_id": "example" }'

Authorizations

• BasicAuth
• Token
• AccessToken
• AuthorizationHeaderToken
• SudoParam
• SudoHeader
• TOTPHeader

Parameters

Path Parameters

owner

required

string

Owner of the repo

repo

required

string

Name of the repo

branch

required

string

Name of the branch

Request Body

Media typeapplication/json

UpdateBranchRepoOption options when updating a branch reference in a repository

object

force

Force update even if the change is not a fast-forward

boolean

new_commit_id

required

New commit SHA (or any ref) the branch should point to

string

old_commit_id

Expected old commit SHA of the branch; if provided it must match the current tip

string

Example^generated

{
  "force": true,
  "new_commit_id": "example",
  "old_commit_id": "example"
}

Responses

204

APIEmpty is an empty response

Media typeapplication/json

403

APIForbiddenError is a forbidden error response

Media typeapplication/json

Headers

message

string

url

string

404

APINotFound is a not found empty response

Media typeapplication/json

409

APIConflict is a conflict empty response

Media typeapplication/json

422

APIValidationError is error format response related to input validation

Media typeapplication/json

Headers

message

string

url

string