Start the pull mirroring process for a project

POST

/api/v4/projects/{id}/mirror/pull

• GitLab REST API

Starts the pull mirroring process for a specified project.

Authorizations

• http
• oauth2

Parameters

Path Parameters

id

required

One of:

string

string

integer

integer

The ID or URL-encoded path of the project

Request Body

Media typeapplication/json

object

action

Pull Request action

string

nullable

pull_request.number

Pull request IID

integer

nullable

pull_request.head.ref

Source branch

string

nullable

pull_request.head.sha

Source sha

string

nullable

pull_request.head.repo.full_name

Source repository

string

nullable

pull_request.base.ref

Target branch

string

nullable

pull_request.base.sha

Target sha

string

nullable

pull_request.base.repo.full_name

Target repository

string

nullable

force

Reset the mirror if it is in a hard-failed state and retry the update

boolean

nullable

Example^generated

{
  "action": "example",
  "pull_request.number": 1,
  "pull_request.head.ref": "example",
  "pull_request.head.sha": "example",
  "pull_request.head.repo.full_name": "example",
  "pull_request.base.ref": "example",
  "pull_request.base.sha": "example",
  "pull_request.base.repo.full_name": "example",
  "force": true
}

Responses

200

OK

400

The project is not mirrored

403

Mirroring for the project is on pause

404

Not Found

422

The pull request event is not processable