Skip to content
forgit api docs

Set up a new push mirror in a repository

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

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
owner
required
string

Owner of the repo

repo
required
string

Name of the repo

Request Body

Section titled “Request Body”
Media typeapplication/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
Examplegenerated
{
  "branch_filter": "example",
  "interval": "example",
  "remote_address": "example",
  "remote_password": "example",
  "remote_username": "example",
  "sync_on_commit": true,
  "use_ssh": true
}

Responses

Section titled “Responses”

200

Section titled “200”

PushMirror

Media typeapplication/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
Examplegenerated
{
  "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

Section titled “400”

APIError is error format response

Media typeapplication/json

APIError is an api error with a message

object
message
string
url
string
Examplegenerated
{
  "message": "example",
  "url": "example"
}

403

Section titled “403”

APIForbiddenError is a forbidden error response

Media typeapplication/json
object
message
string
url
string
Examplegenerated
{
  "message": "example",
  "url": "example"
}

404

Section titled “404”

APINotFound is a not found error response

Media typeapplication/json
object
errors
Array<string>
message
string
url
string
Examplegenerated
{
  "errors": [
    "example"
  ],
  "message": "example",
  "url": "example"
}

413

Section titled “413”

QuotaExceeded

Media typeapplication/json

Headers

Section titled “Headers”
message
string
user_id
integer format: int64
username
string