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.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST 'https://api.github.com/repos///merge-upstream' \
--header 'Content-Type: application/json' \
--data-raw '{
    "branch": "main"
}'

Response Example

200 - Example 1

{
    "base_branch": "string",
    "merge_type": "merge",
    "message": "string"
}

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.

Body Params application/json

branch

string

required

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

Examples

Responses

🟢200The branch has been successfully synced with the upstream repository

application/json

Body

Results of a successful merge upstream request

base_branch

string

optional

merge_type

enum<string>

optional

Allowed values:

mergefast-forwardnone

message

string

optional

🟠409The branch could not be synced because of a merge conflict

🟠422The branch could not be synced for some other reason

Modified at 2023-08-15 02:59:24

Enable Git LFS for a repository

Merge a branch