Set up a new push mirror in a repository

POST

/repos/{owner}/{repo}/push_mirrors

Authorizations

• BasicAuth
• AuthorizationHeaderToken
• SudoParam
• SudoHeader
• TOTPHeader

Parameters

Path Parameters

owner

required

string

Owner of the repo

repo

required

string

Name of the repo

Request Body

Media type application/json

CreatePushMirrorOption represents need information to create a push mirror of a repository.

object

branch_filter

string

interval

string

remote_address

string

remote_password

string

remote_username

string

sync_on_commit

boolean

use_ssh

boolean

Example ^generated

{
  "branch_filter": "example",
  "interval": "example",
  "remote_address": "example",
  "remote_password": "example",
  "remote_username": "example",
  "sync_on_commit": true,
  "use_ssh": true
}

Responses

200

PushMirror

Media type application/json

PushMirror represents information of a push mirror

object

branch_filter

string

created

string format: date-time

interval

string

last_error

string

last_update

string format: date-time

public_key

string

remote_address

string

remote_name

string

repo_name

string

sync_on_commit

boolean

Example ^generated

{
  "branch_filter": "example",
  "created": "2026-04-15T12:00:00Z",
  "interval": "example",
  "last_error": "example",
  "last_update": "2026-04-15T12:00:00Z",
  "public_key": "example",
  "remote_address": "example",
  "remote_name": "example",
  "repo_name": "example",
  "sync_on_commit": true
}

400

APIError is error format response

Media type application/json

APIError is an api error with a message

object

message

string

url

string

Example ^generated

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

403

APIForbiddenError is a forbidden error response

Media type application/json

object

message

string

url

string

Example ^generated

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

404

APINotFound is a not found error response

Media type application/json

object

errors

Array<string>

message

string

url

string

Example ^generated

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

413

QuotaExceeded

Media type application/json

Headers

message

string

user_id

integer format: int64

username

string