Sync a fork branch with the upstream repository

POST

/repos/{owner}/{repo}/merge-upstream

Sync a branch of a forked repository to keep it up-to-date with the upstream repository.

API method documentation

Parameters

Path Parameters

owner

required

string

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

repo

required

string

The name of the repository without the .git extension. The name is not case sensitive.

Request Body^required

Media typeapplication/json

object

branch

required

The name of the branch which should be updated to match upstream.

string

Examples

Exampledefault

{
  "branch": "main"
}

Responses

200

The branch has been successfully synced with the upstream repository

Media typeapplication/json

Merged upstream

Results of a successful merge upstream request

object

message

string

merge_type

string

Allowed values: merge fast-forward none

base_branch

string

Examples

Exampledefault

{
  "message": "Successfully fetched and fast-forwarded from upstream defunkt:main",
  "merge_type": "fast-forward",
  "base_branch": "defunkt:main"
}

409

The branch could not be synced because of a merge conflict

422

The branch could not be synced for some other reason