Gets information about syncing a fork branch with the base branch

GET

/repos/{owner}/{repo}/sync_fork/{branch}

Authorizations

• BasicAuth
• AuthorizationHeaderToken
• SudoParam
• SudoHeader
• TOTPHeader

Parameters

Path Parameters

owner

required

string

Owner of the repo

repo

required

string

Name of the repo

branch

required

string

The branch

Responses

200

SyncForkInfo

Media typeapplication/json

SyncForkInfo information about syncing a fork

object

allowed

boolean

base_commit

string

commits_behind

integer format: int64

fork_commit

string

Example^generated

{
  "allowed": true,
  "base_commit": "example",
  "commits_behind": 1,
  "fork_commit": "example"
}

400

APIError is error format response

Media typeapplication/json

APIError is an api error with a message

object

message

string

url

string

Example^generated

{
  "message": "example",
  "url": "example"
}

404

APINotFound is a not found error response

Media typeapplication/json

object

errors

Array<string>

message

string

url

string

Example^generated

{
  "errors": [
    "example"
  ],
  "message": "example",
  "url": "example"
}