Create a merge request pipeline

POST

/api/v4/projects/{id}/merge_requests/{merge_request_iid}/pipelines

• GitLab REST API

Creates a merge request pipeline. Pipelines created with this operation must configure .gitlab-ci.yml with only: [merge_requests] to create jobs.

Authorizations

• http
• oauth2

Parameters

Path Parameters

id

required

One of:

string

string

integer

integer

The ID or URL-encoded path of the project.

merge_request_iid

required

integer

The IID of a merge request

Request Body

Media type application/json

object

async

Indicates if the merge request pipeline creation should be performed asynchronously. If set to true, the pipeline will be created outside of the API request and the endpoint will return an empty response with a 202 status code. When the response is 202, the creation can still fail outside of this request.

boolean

nullable

Example ^generated

{
  "async": true
}

Responses

201

Created

Media type application/json

object

id

integer format: int64

iid

integer

project_id

integer format: int64

sha

string

ref

string

status

string

source

string

created_at

string format: date-time

updated_at

string format: date-time

web_url

string

before_sha

string

tag

boolean

yaml_errors

string

user

object

id

integer format: int64

username

string

public_email

string

name

string

state

string

locked

boolean

avatar_url

string

avatar_path

string

custom_attributes

Array<object>

object

key

string

value

string

web_url

string

started_at

string format: date-time

finished_at

string format: date-time

committed_at

string format: date-time

duration

Time spent running in seconds

integer

queued_duration

Time spent enqueued in seconds

integer

coverage

number format: float

detailed_status

object

icon

string

text

string

label

string

group

string

tooltip

string

has_details

boolean

details_path

string

illustration

object

favicon

string

action

string

archived

boolean

Example

{
  "id": 1,
  "iid": 2,
  "project_id": 3,
  "sha": "0ec9e58fdfca6cdd6652c083c9edb53abc0bad52",
  "ref": "feature-branch",
  "status": "success",
  "source": "push",
  "created_at": "2015-12-24T15:51:21.880Z",
  "updated_at": "2015-12-24T17:54:31.198Z",
  "web_url": "https://gitlab.example.com/gitlab-org/gitlab-foss/-/pipelines/61",
  "before_sha": "a91957a858320c0e17f3a0eca7cfacbff50ea29a",
  "tag": false,
  "yaml_errors": "widgets:build: needs 'widgets:test'",
  "user": {
    "id": 1,
    "username": "admin",
    "public_email": "john@example.com",
    "name": "Administrator",
    "state": "active",
    "avatar_url": "https://gravatar.com/avatar/1",
    "avatar_path": "/user/avatar/28/The-Big-Lebowski-400-400.png",
    "custom_attributes": [
      {
        "key": "foo",
        "value": "bar"
      }
    ],
    "web_url": "https://gitlab.example.com/root"
  },
  "started_at": "2015-12-24T17:54:30.733Z",
  "finished_at": "2015-12-24T17:54:31.198Z",
  "committed_at": "2015-12-24T15:51:21.880Z",
  "duration": 127,
  "queued_duration": 63,
  "coverage": 98.29,
  "detailed_status": {
    "icon": "status_success",
    "text": "passed",
    "label": "passed",
    "group": "success",
    "tooltip": "passed",
    "has_details": true,
    "details_path": "/test-group/test-project/-/pipelines/287",
    "illustration": {
      "image": "illustrations/empty-state/empty-job-not-triggered-md.svg",
      "size": "",
      "title": "This job has not been triggered yet",
      "content": "This job depends on upstream jobs that need to succeed in order for this job to be triggered"
    },
    "favicon": "/assets/ci_favicons/favicon_status_success.png"
  },
  "archived": false
}

400

Bad request

404

Not found

405

Method not allowed