merge_requests.md 74.6 KB
Newer Older
1
# Merge requests API
Marin Jankovski's avatar
Marin Jankovski committed
2

3 4
Every API call to merge requests must be authenticated.

Valeriy Sizov's avatar
Valeriy Sizov committed
5 6
## List merge requests

7 8 9 10 11 12
> [Introduced][ce-13060] in GitLab 9.5.

Get all merge requests the authenticated user has access to. By
default it returns only merge requests created by the current user. To
get all merge requests, use parameter `scope=all`.

13
The `state` parameter can be used to get only merge requests with a
14
given state (`opened`, `closed`, `locked`, or `merged`) or all of them (`all`). It should be noted that when searching by `locked` it will mostly return no results as it is a short-lived, transitional state.
15 16 17 18 19 20 21 22 23 24
The pagination parameters `page` and `per_page` can be used to
restrict the list of merge requests.

```
GET /merge_requests
GET /merge_requests?state=opened
GET /merge_requests?state=all
GET /merge_requests?milestone=release
GET /merge_requests?labels=bug,reproduced
GET /merge_requests?author_id=5
25
GET /merge_requests?my_reaction_emoji=star
26
GET /merge_requests?scope=assigned_to_me
27
GET /merge_requests?search=foo&in=title
28 29 30 31
```

Parameters:

32 33
| Attribute           | Type     | Required | Description                                                                                                            |
| ------------------- | -------- | -------- | ---------------------------------------------------------------------------------------------------------------------- |
Heinrich Lee Yu's avatar
Heinrich Lee Yu committed
34
| `state`             | string   | no       | Return all merge requests or just those that are `opened`, `closed`, `locked`, or `merged`                             |
35 36
| `order_by`          | string   | no       | Return requests ordered by `created_at` or `updated_at` fields. Default is `created_at`                                |
| `sort`              | string   | no       | Return requests sorted in `asc` or `desc` order. Default is `desc`                                                     |
Heinrich Lee Yu's avatar
Heinrich Lee Yu committed
37
| `milestone`         | string   | no       | Return merge requests for a specific milestone. `None` returns merge requests with no milestone. `Any` returns merge requests that have an assigned milestone. |
38
| `view`              | string   | no       | If `simple`, returns the `iid`, URL, title, description, and basic state of merge request                              |
39
| `labels`            | string   | no       | Return merge requests matching a comma separated list of labels. `None` lists all merge requests with no labels. `Any` lists all merge requests with at least one label. `No+Label` (Deprecated) lists all merge requests with no labels. Predefined names are case-insensitive. |
40 41 42 43
| `created_after`     | datetime | no       | Return merge requests created on or after the given time                                                               |
| `created_before`    | datetime | no       | Return merge requests created on or before the given time                                                              |
| `updated_after`     | datetime | no       | Return merge requests updated on or after the given time                                                               |
| `updated_before`    | datetime | no       | Return merge requests updated on or before the given time                                                              |
44 45
| `scope`             | string   | no       | Return merge requests for the given scope: `created_by_me`, `assigned_to_me` or `all`. Defaults to `created_by_me`<br> For versions before 11.0, use the now deprecated `created-by-me` or `assigned-to-me` scopes instead. |
| `author_id`         | integer  | no       | Returns merge requests created by the given user `id`. Combine with `scope=all` or `scope=assigned_to_me`              |
Heinrich Lee Yu's avatar
Heinrich Lee Yu committed
46
| `assignee_id`       | integer  | no       | Returns merge requests assigned to the given user `id`. `None` returns unassigned merge requests. `Any` returns merge requests with an assignee. |
Heinrich Lee Yu's avatar
Heinrich Lee Yu committed
47
| `my_reaction_emoji` | string   | no       | Return merge requests reacted by the authenticated user by the given `emoji`. `None` returns issues not given a reaction. `Any` returns issues given at least one reaction. _([Introduced][ce-14016] in GitLab 10.0)_ |
48 49
| `source_branch`     | string   | no       | Return merge requests with the given source branch                                                                     |
| `target_branch`     | string   | no       | Return merge requests with the given target branch                                                                     |
50
| `search`            | string   | no       | Search merge requests against their `title` and `description`                                                          |
Hiroyuki Sato's avatar
Hiroyuki Sato committed
51
| `in`                | string   | no       | Modify the scope of the `search` attribute. `title`, `description`, or a string joining them with comma. Default is `title,description` |
Heinrich Lee Yu's avatar
Heinrich Lee Yu committed
52
| `wip`               | string   | no       | Filter merge requests against their `wip` status. `yes` to return *only* WIP merge requests, `no` to return *non* WIP merge requests |
53 54 55 56 57 58 59 60

```json
[
  {
    "id": 1,
    "iid": 1,
    "project_id": 3,
    "title": "test1",
61
    "description": "fixed login page css paddings",
62 63 64 65 66 67 68 69 70 71 72 73
    "state": "merged",
    "merged_by": {
      "id": 87854,
      "name": "Douwe Maan",
      "username": "DouweM",
      "state": "active",
      "avatar_url": "https://gitlab.example.com/uploads/-/system/user/avatar/87854/avatar.png",
      "web_url": "https://gitlab.com/DouweM"
    },
    "merged_at": "2018-09-07T11:16:17.520Z",
    "closed_by": null,
    "closed_at": null,
74 75
    "created_at": "2017-04-29T08:46:00Z",
    "updated_at": "2017-04-29T08:46:00Z",
76 77
    "target_branch": "master",
    "source_branch": "test1",
78 79 80 81 82
    "upvotes": 0,
    "downvotes": 0,
    "author": {
      "id": 1,
      "name": "Administrator",
83
      "username": "admin",
84
      "state": "active",
85 86
      "avatar_url": null,
      "web_url" : "https://gitlab.example.com/admin"
87 88 89 90
    },
    "assignee": {
      "id": 1,
      "name": "Administrator",
91
      "username": "admin",
92
      "state": "active",
93 94
      "avatar_url": null,
      "web_url" : "https://gitlab.example.com/admin"
95 96 97
    },
    "source_project_id": 2,
    "target_project_id": 3,
98 99 100 101
    "labels": [
      "Community contribution",
      "Manage"
    ],
102 103 104 105 106 107 108 109 110 111
    "work_in_progress": false,
    "milestone": {
      "id": 5,
      "iid": 1,
      "project_id": 3,
      "title": "v2.0",
      "description": "Assumenda aut placeat expedita exercitationem labore sunt enim earum.",
      "state": "closed",
      "created_at": "2015-02-02T19:49:26.013Z",
      "updated_at": "2015-02-02T19:49:26.013Z",
112 113 114
      "due_date": "2018-09-22",
      "start_date": "2018-08-08",
      "web_url": "https://gitlab.example.com/my-group/my-project/milestones/1"
115 116 117 118 119 120
    },
    "merge_when_pipeline_succeeds": true,
    "merge_status": "can_be_merged",
    "sha": "8888888888888888888888888888888888888888",
    "merge_commit_sha": null,
    "user_notes_count": 1,
121
    "discussion_locked": null,
122 123
    "should_remove_source_branch": true,
    "force_remove_source_branch": false,
124 125 126
    "allow_collaboration": false,
    "allow_maintainer_to_push": false,
    "web_url": "http://gitlab.example.com/my-group/my-project/merge_requests/1",
127 128 129 130 131
    "time_stats": {
      "time_estimate": 0,
      "total_time_spent": 0,
      "human_time_estimate": null,
      "human_total_time_spent": null
132 133
    },
    "squash": false
134 135 136 137 138 139
  }
]
```

## List project merge requests

140
Get all merge requests for this project.
141
The `state` parameter can be used to get only merge requests with a given state (`opened`, `closed`, `locked`, or `merged`) or all of them (`all`).
142
The pagination parameters `page` and `per_page` can be used to restrict the list of merge requests.
Valeriy Sizov's avatar
Valeriy Sizov committed
143 144

```
145
GET /projects/:id/merge_requests
146 147
GET /projects/:id/merge_requests?state=opened
GET /projects/:id/merge_requests?state=all
148
GET /projects/:id/merge_requests?iids[]=42&iids[]=43
149
GET /projects/:id/merge_requests?milestone=release
150
GET /projects/:id/merge_requests?labels=bug,reproduced
151
GET /projects/:id/merge_requests?my_reaction_emoji=star
Valeriy Sizov's avatar
Valeriy Sizov committed
152 153
```

154 155 156 157 158 159 160 161 162
`project_id` represents the ID of the project where the MR resides.
`project_id` will always equal `target_project_id`.

In the case of a merge request from the same project,
`source_project_id`, `target_project_id` and `project_id`
will be the same. In the case of a merge request from a fork,
`target_project_id` and `project_id` will be the same and
`source_project_id` will be the fork project's ID.

Valeriy Sizov's avatar
Valeriy Sizov committed
163 164
Parameters:

Hiroyuki Sato's avatar
Hiroyuki Sato committed
165 166 167 168
| Attribute           | Type           | Required | Description                                                                                                                    |
| ------------------- | -------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------ |
| `id`                | integer        | yes      | The ID of a project                                                                                                            |
| `iids[]`            | Array[integer] | no       | Return the request having the given `iid`                                                                                      |
Heinrich Lee Yu's avatar
Heinrich Lee Yu committed
169
| `state`             | string         | no       | Return all merge requests or just those that are `opened`, `closed`, `locked`, or `merged`                                     |
Hiroyuki Sato's avatar
Hiroyuki Sato committed
170 171
| `order_by`          | string         | no       | Return requests ordered by `created_at` or `updated_at` fields. Default is `created_at`                                        |
| `sort`              | string         | no       | Return requests sorted in `asc` or `desc` order. Default is `desc`                                                             |
Heinrich Lee Yu's avatar
Heinrich Lee Yu committed
172
| `milestone`         | string         | no       | Return merge requests for a specific milestone. `None` returns merge requests with no milestone. `Any` returns merge requests that have an assigned milestone. |
Hiroyuki Sato's avatar
Hiroyuki Sato committed
173
| `view`              | string         | no       | If `simple`, returns the `iid`, URL, title, description, and basic state of merge request                                      |
174
| `labels`            | string         | no       | Return merge requests matching a comma separated list of labels. `None` lists all merge requests with no labels. `Any` lists all merge requests with at least one label. `No+Label` (Deprecated) lists all merge requests with no labels. Predefined names are case-insensitive. |
175 176 177 178
| `created_after`     | datetime       | no       | Return merge requests created on or after the given time                                                                       |
| `created_before`    | datetime       | no       | Return merge requests created on or before the given time                                                                      |
| `updated_after`     | datetime       | no       | Return merge requests updated on or after the given time                                                                       |
| `updated_before`    | datetime       | no       | Return merge requests updated on or before the given time                                                                      |
179
| `scope`             | string         | no       | Return merge requests for the given scope: `created_by_me`, `assigned_to_me` or `all`.<br> For versions before 11.0, use the now deprecated `created-by-me` or `assigned-to-me` scopes instead.<br> _([Introduced][ce-13060] in GitLab 9.5. [Changed to snake_case][ce-18935] in GitLab 11.0)_ |
Hiroyuki Sato's avatar
Hiroyuki Sato committed
180
| `author_id`         | integer        | no       | Returns merge requests created by the given user `id` _([Introduced][ce-13060] in GitLab 9.5)_                                 |
Heinrich Lee Yu's avatar
Heinrich Lee Yu committed
181
| `assignee_id`       | integer        | no       | Returns merge requests assigned to the given user `id`. `None` returns unassigned merge requests. `Any` returns merge requests with an assignee. _([Introduced][ce-13060] in GitLab 9.5)_ |
Heinrich Lee Yu's avatar
Heinrich Lee Yu committed
182
| `my_reaction_emoji` | string         | no       | Return merge requests reacted by the authenticated user by the given `emoji`. `None` returns issues not given a reaction. `Any` returns issues given at least one reaction. _([Introduced][ce-14016] in GitLab 10.0)_ |
Heinrich Lee Yu's avatar
Heinrich Lee Yu committed
183 184
| `source_branch`     | string         | no       | Return merge requests with the given source branch                                                                             |
| `target_branch`     | string         | no       | Return merge requests with the given target branch                                                                             |
185
| `search`            | string         | no       | Search merge requests against their `title` and `description`                                                                  |
186
| `wip`               | string         | no       | Filter merge requests against their `wip` status. `yes` to return *only* WIP merge requests, `no` to return *non* WIP merge requests |
Valeriy Sizov's avatar
Valeriy Sizov committed
187 188 189

```json
[
Johannes Schleifenbaum's avatar
Johannes Schleifenbaum committed
190 191 192 193 194
  {
    "id": 1,
    "iid": 1,
    "project_id": 3,
    "title": "test1",
195
    "description": "fixed login page css paddings",
196 197 198 199 200 201 202 203 204 205 206 207
    "state": "merged",
    "merged_by": {
      "id": 87854,
      "name": "Douwe Maan",
      "username": "DouweM",
      "state": "active",
      "avatar_url": "https://gitlab.example.com/uploads/-/system/user/avatar/87854/avatar.png",
      "web_url": "https://gitlab.com/DouweM"
    },
    "merged_at": "2018-09-07T11:16:17.520Z",
    "closed_by": null,
    "closed_at": null,
208 209
    "created_at": "2017-04-29T08:46:00Z",
    "updated_at": "2017-04-29T08:46:00Z",
210 211
    "target_branch": "master",
    "source_branch": "test1",
Johannes Schleifenbaum's avatar
Johannes Schleifenbaum committed
212 213 214 215 216
    "upvotes": 0,
    "downvotes": 0,
    "author": {
      "id": 1,
      "name": "Administrator",
217
      "username": "admin",
Johannes Schleifenbaum's avatar
Johannes Schleifenbaum committed
218
      "state": "active",
219 220
      "avatar_url": null,
      "web_url" : "https://gitlab.example.com/admin"
Johannes Schleifenbaum's avatar
Johannes Schleifenbaum committed
221 222 223 224
    },
    "assignee": {
      "id": 1,
      "name": "Administrator",
225
      "username": "admin",
Johannes Schleifenbaum's avatar
Johannes Schleifenbaum committed
226
      "state": "active",
227 228
      "avatar_url": null,
      "web_url" : "https://gitlab.example.com/admin"
229
    },
Ben Boeckel's avatar
Ben Boeckel committed
230 231
    "source_project_id": 2,
    "target_project_id": 3,
232 233 234 235
    "labels": [
      "Community contribution",
      "Manage"
    ],
236 237 238 239 240 241 242 243 244 245
    "work_in_progress": false,
    "milestone": {
      "id": 5,
      "iid": 1,
      "project_id": 3,
      "title": "v2.0",
      "description": "Assumenda aut placeat expedita exercitationem labore sunt enim earum.",
      "state": "closed",
      "created_at": "2015-02-02T19:49:26.013Z",
      "updated_at": "2015-02-02T19:49:26.013Z",
246 247 248
      "due_date": "2018-09-22",
      "start_date": "2018-08-08",
      "web_url": "https://gitlab.example.com/my-group/my-project/milestones/1"
249
    },
250
    "merge_when_pipeline_succeeds": true,
251
    "merge_status": "can_be_merged",
252 253
    "sha": "8888888888888888888888888888888888888888",
    "merge_commit_sha": null,
254
    "user_notes_count": 1,
255
    "discussion_locked": null,
256
    "should_remove_source_branch": true,
257
    "force_remove_source_branch": false,
258 259 260
    "allow_collaboration": false,
    "allow_maintainer_to_push": false,
    "web_url": "http://gitlab.example.com/my-group/my-project/merge_requests/1",
261 262 263 264 265
    "time_stats": {
      "time_estimate": 0,
      "total_time_spent": 0,
      "human_time_estimate": null,
      "human_total_time_spent": null
266 267
    },
    "squash": false
Johannes Schleifenbaum's avatar
Johannes Schleifenbaum committed
268
  }
Valeriy Sizov's avatar
Valeriy Sizov committed
269 270 271
]
```

272 273 274
## List group merge requests

Get all merge requests for this group and its subgroups.
275
The `state` parameter can be used to get only merge requests with a given state (`opened`, `closed`, `locked`, or `merged`) or all of them (`all`).
276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292
The pagination parameters `page` and `per_page` can be used to restrict the list of merge requests.

```
GET /groups/:id/merge_requests
GET /groups/:id/merge_requests?state=opened
GET /groups/:id/merge_requests?state=all
GET /groups/:id/merge_requests?milestone=release
GET /groups/:id/merge_requests?labels=bug,reproduced
GET /groups/:id/merge_requests?my_reaction_emoji=star
```

`group_id` represents the ID of the group which contains the project where the MR resides.

Parameters:

| Attribute           | Type           | Required | Description                                                                                                                    |
| ------------------- | -------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------ |
Heinrich Lee Yu's avatar
Heinrich Lee Yu committed
293 294 295 296 297
| `id`                | integer        | yes      | The ID of a group                                                                                                              |
| `state`             | string         | no       | Return all merge requests or just those that are `opened`, `closed`, `locked`, or `merged`                                     |
| `order_by`          | string         | no       | Return merge requests ordered by `created_at` or `updated_at` fields. Default is `created_at`                                  |
| `sort`              | string         | no       | Return merge requests sorted in `asc` or `desc` order. Default is `desc`                                                       |
| `milestone`         | string         | no       | Return merge requests for a specific milestone. `None` returns merge requests with no milestone. `Any` returns merge requests that have an assigned milestone. |
298
| `view`              | string         | no       | If `simple`, returns the `iid`, URL, title, description, and basic state of merge request                                      |
299
| `labels`            | string         | no       | Return merge requests matching a comma separated list of labels. `None` lists all merge requests with no labels. `Any` lists all merge requests with at least one label. `No+Label` (Deprecated) lists all merge requests with no labels. Predefined names are case-insensitive. |
300 301 302 303 304 305
| `created_after`     | datetime       | no       | Return merge requests created on or after the given time                                                                       |
| `created_before`    | datetime       | no       | Return merge requests created on or before the given time                                                                      |
| `updated_after`     | datetime       | no       | Return merge requests updated on or after the given time                                                                       |
| `updated_before`    | datetime       | no       | Return merge requests updated on or before the given time                                                                      |
| `scope`             | string         | no       | Return merge requests for the given scope: `created_by_me`, `assigned_to_me` or `all`.<br>                                     |
| `author_id`         | integer        | no       | Returns merge requests created by the given user `id` _([Introduced][ce-13060] in GitLab 9.5)_                                 |
Heinrich Lee Yu's avatar
Heinrich Lee Yu committed
306
| `assignee_id`       | integer        | no       | Returns merge requests assigned to the given user `id`. `None` returns unassigned merge requests. `Any` returns merge requests with an assignee. _([Introduced][ce-13060] in GitLab 9.5)_ |
Heinrich Lee Yu's avatar
Heinrich Lee Yu committed
307
| `my_reaction_emoji` | string         | no       | Return merge requests reacted by the authenticated user by the given `emoji`. `None` returns issues not given a reaction. `Any` returns issues given at least one reaction. _([Introduced][ce-14016] in GitLab 10.0)_ |
Heinrich Lee Yu's avatar
Heinrich Lee Yu committed
308 309
| `source_branch`     | string         | no       | Return merge requests with the given source branch                                                                             |
| `target_branch`     | string         | no       | Return merge requests with the given target branch                                                                             |
310 311 312 313 314 315 316 317 318
| `search`            | string         | no       | Search merge requests against their `title` and `description`                                                                  |

```json
[
  {
    "id": 1,
    "iid": 1,
    "project_id": 3,
    "title": "test1",
319
    "description": "fixed login page css paddings",
320 321 322 323 324 325 326 327 328 329 330 331
    "state": "merged",
    "merged_by": {
      "id": 87854,
      "name": "Douwe Maan",
      "username": "DouweM",
      "state": "active",
      "avatar_url": "https://gitlab.example.com/uploads/-/system/user/avatar/87854/avatar.png",
      "web_url": "https://gitlab.com/DouweM"
    },
    "merged_at": "2018-09-07T11:16:17.520Z",
    "closed_by": null,
    "closed_at": null,
332 333
    "created_at": "2017-04-29T08:46:00Z",
    "updated_at": "2017-04-29T08:46:00Z",
334 335
    "target_branch": "master",
    "source_branch": "test1",
336 337 338 339 340
    "upvotes": 0,
    "downvotes": 0,
    "author": {
      "id": 1,
      "name": "Administrator",
341
      "username": "admin",
342
      "state": "active",
343 344
      "avatar_url": null,
      "web_url" : "https://gitlab.example.com/admin"
345 346 347 348
    },
    "assignee": {
      "id": 1,
      "name": "Administrator",
349
      "username": "admin",
350
      "state": "active",
351 352
      "avatar_url": null,
      "web_url" : "https://gitlab.example.com/admin"
353 354 355
    },
    "source_project_id": 2,
    "target_project_id": 3,
356 357 358 359
    "labels": [
      "Community contribution",
      "Manage"
    ],
360 361 362 363 364 365 366 367 368 369
    "work_in_progress": false,
    "milestone": {
      "id": 5,
      "iid": 1,
      "project_id": 3,
      "title": "v2.0",
      "description": "Assumenda aut placeat expedita exercitationem labore sunt enim earum.",
      "state": "closed",
      "created_at": "2015-02-02T19:49:26.013Z",
      "updated_at": "2015-02-02T19:49:26.013Z",
370 371 372
      "due_date": "2018-10-22",
      "start_date": "2018-09-08",
      "web_url": "gitlab.example.com/my-group/my-project/milestones/1"
373 374 375 376 377 378
    },
    "merge_when_pipeline_succeeds": true,
    "merge_status": "can_be_merged",
    "sha": "8888888888888888888888888888888888888888",
    "merge_commit_sha": null,
    "user_notes_count": 1,
379
    "discussion_locked": null,
380 381
    "should_remove_source_branch": true,
    "force_remove_source_branch": false,
382
    "web_url": "http://gitlab.example.com/my-group/my-project/merge_requests/1",
383 384 385 386 387
    "time_stats": {
      "time_estimate": 0,
      "total_time_spent": 0,
      "human_time_estimate": null,
      "human_total_time_spent": null
388 389
    },
    "squash": false
390 391 392 393
  }
]
```

394 395
## Get single MR

396
Shows information about a single merge request.
Valeriy Sizov's avatar
Valeriy Sizov committed
397

398 399 400 401 402
**Note**: the `changes_count` value in the response is a string, not an
integer. This is because when an MR has too many changes to display and store,
it will be capped at 1,000. In that case, the API will return the string
`"1000+"` for the changes count.

Valeriy Sizov's avatar
Valeriy Sizov committed
403
```
404
GET /projects/:id/merge_requests/:merge_request_iid
Valeriy Sizov's avatar
Valeriy Sizov committed
405 406 407 408
```

Parameters:

409
- `id` (required) - The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user
410
- `merge_request_iid` (required) - The internal ID of the merge request
Phil Hughes's avatar
Phil Hughes committed
411
- `render_html` (optional) - If `true` response includes rendered HTML for title and description
412
- `include_diverged_commits_count` (optional) - If `true` response includes the commits behind the target branch
413
- `include_rebase_in_progress` (optional) - If `true` response includes whether a rebase operation is in progress
Valeriy Sizov's avatar
Valeriy Sizov committed
414 415 416

```json
{
Johannes Schleifenbaum's avatar
Johannes Schleifenbaum committed
417 418 419 420
  "id": 1,
  "iid": 1,
  "project_id": 3,
  "title": "test1",
421
  "description": "fixed login page css paddings",
422
  "state": "merged",
423 424
  "created_at": "2017-04-29T08:46:00Z",
  "updated_at": "2017-04-29T08:46:00Z",
425 426
  "target_branch": "master",
  "source_branch": "test1",
Johannes Schleifenbaum's avatar
Johannes Schleifenbaum committed
427 428 429
  "upvotes": 0,
  "downvotes": 0,
  "author": {
430 431 432 433 434 435
    "id": 1,
    "name": "Administrator",
    "username": "admin",
    "state": "active",
    "avatar_url": null,
    "web_url" : "https://gitlab.example.com/admin"
Johannes Schleifenbaum's avatar
Johannes Schleifenbaum committed
436
  },
437 438 439
  "user" : {
    "can_merge" : false
   }
Johannes Schleifenbaum's avatar
Johannes Schleifenbaum committed
440
  "assignee": {
441 442 443 444 445 446
    "id": 1,
    "name": "Administrator",
    "username": "admin",
    "state": "active",
    "avatar_url": null,
    "web_url" : "https://gitlab.example.com/admin"
447
  },
Ben Boeckel's avatar
Ben Boeckel committed
448 449
  "source_project_id": 2,
  "target_project_id": 3,
450 451 452 453
  "labels": [
    "Community contribution",
    "Manage"
  ],
454 455 456 457 458 459 460 461 462 463
  "work_in_progress": false,
  "milestone": {
    "id": 5,
    "iid": 1,
    "project_id": 3,
    "title": "v2.0",
    "description": "Assumenda aut placeat expedita exercitationem labore sunt enim earum.",
    "state": "closed",
    "created_at": "2015-02-02T19:49:26.013Z",
    "updated_at": "2015-02-02T19:49:26.013Z",
464 465 466
    "due_date": "2018-09-22",
    "start_date": "2018-08-08",
    "web_url": "https://gitlab.example.com/my-group/my-project/milestones/1"
467
  },
468
  "merge_when_pipeline_succeeds": true,
469
  "merge_status": "can_be_merged",
470
  "merge_error": null,
471
  "sha": "8888888888888888888888888888888888888888",
472
  "merge_commit_sha": null,
473
  "user_notes_count": 1,
474
  "discussion_locked": null,
475
  "should_remove_source_branch": true,
476
  "force_remove_source_branch": false,
477 478 479
  "allow_collaboration": false,
  "allow_maintainer_to_push": false,
  "web_url": "http://gitlab.example.com/my-group/my-project/merge_requests/1",
480 481 482 483 484
  "time_stats": {
    "time_estimate": 0,
    "total_time_spent": 0,
    "human_time_estimate": null,
    "human_total_time_spent": null
haseeb's avatar
haseeb committed
485
  },
486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501
  "squash": false,
  "subscribed": false,
  "changes_count": "1",
  "merged_by": {
    "id": 87854,
    "name": "Douwe Maan",
    "username": "DouweM",
    "state": "active",
    "avatar_url": "https://gitlab.example.com/uploads/-/system/user/avatar/87854/avatar.png",
    "web_url": "https://gitlab.com/DouweM"
  },
  "merged_at": "2018-09-07T11:16:17.520Z",
  "closed_by": null,
  "closed_at": null,
  "latest_build_started_at": "2018-09-07T07:27:38.472Z",
  "latest_build_finished_at": "2018-09-07T08:07:06.012Z",
haseeb's avatar
haseeb committed
502 503
  "first_deployed_to_production_at": null,
  "pipeline": {
504 505 506 507 508
    "id": 29626725,
    "sha": "2be7ddb704c7b6b83732fdd5b9f09d5a397b5f8f",
    "ref": "patch-28",
    "status": "success",
    "web_url": "https://gitlab.example.com/my-group/my-project/pipelines/29626725"
509
  },
510
  "diff_refs": {
511 512 513
    "base_sha": "c380d3acebd181f13629a25d2e2acca46ffe1e00",
    "head_sha": "2be7ddb704c7b6b83732fdd5b9f09d5a397b5f8f",
    "start_sha": "c380d3acebd181f13629a25d2e2acca46ffe1e00"
514
  },
515 516
  "diverged_commits_count": 2,
  "rebase_in_progress": false
Valeriy Sizov's avatar
Valeriy Sizov committed
517 518 519
}
```

520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553
## Get single MR participants

Get a list of merge request participants.

```
GET /projects/:id/merge_requests/:merge_request_iid/participants
```

Parameters:

- `id` (required) - The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user
- `merge_request_iid` (required) - The internal ID of the merge request

```json
[
  {
    "id": 1,
    "name": "John Doe1",
    "username": "user1",
    "state": "active",
    "avatar_url": "http://www.gravatar.com/avatar/c922747a93b40d1ea88262bf1aebee62?s=80&d=identicon",
    "web_url": "http://localhost/user1"
  },
  {
    "id": 2,
    "name": "John Doe2",
    "username": "user2",
    "state": "active",
    "avatar_url": "http://www.gravatar.com/avatar/10fc7f102be8de7657fb4d80898bbfe3?s=80&d=identicon",
    "web_url": "http://localhost/user2"
  },
]
```

554 555
## Get single MR commits

Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
556
Get a list of merge request commits.
557 558

```
559
GET /projects/:id/merge_requests/:merge_request_iid/commits
560 561 562 563
```

Parameters:

564
- `id` (required) - The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user
565
- `merge_request_iid` (required) - The internal ID of the merge request
566 567 568 569 570 571 572 573 574 575

```json
[
  {
    "id": "ed899a2f4b50b4370feeea94676502b42383c746",
    "short_id": "ed899a2f4b5",
    "title": "Replace sanitize with escape once",
    "author_name": "Dmitriy Zaporozhets",
    "author_email": "dzaporozhets@sphereconsultinginc.com",
    "created_at": "2012-09-20T11:50:22+03:00",
Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
576
    "message": "Replace sanitize with escape once"
577 578 579 580 581 582 583 584
  },
  {
    "id": "6104942438c14ec7bd21c6cd5bd995272b3faff6",
    "short_id": "6104942438c",
    "title": "Sanitize for network graph",
    "author_name": "randx",
    "author_email": "dmitriy.zaporozhets@gmail.com",
    "created_at": "2012-09-20T09:06:12+03:00",
Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
585
    "message": "Sanitize for network graph"
586 587 588 589
  }
]
```

590 591
## Get single MR changes

592
Shows information about the merge request including its files and changes.
593 594

```
595
GET /projects/:id/merge_requests/:merge_request_iid/changes
596 597 598 599
```

Parameters:

600
- `id` (required) - The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user
601
- `merge_request_iid` (required) - The internal ID of the merge request
602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620

```json
{
  "id": 21,
  "iid": 1,
  "project_id": 4,
  "title": "Blanditiis beatae suscipit hic assumenda et molestias nisi asperiores repellat et.",
  "state": "reopened",
  "created_at": "2015-02-02T19:49:39.159Z",
  "updated_at": "2015-02-02T20:08:49.959Z",
  "target_branch": "secret_token",
  "source_branch": "version-1-9",
  "upvotes": 0,
  "downvotes": 0,
  "author": {
    "name": "Chad Hamill",
    "username": "jarrett",
    "id": 5,
    "state": "active",
621 622
    "avatar_url": "http://www.gravatar.com/avatar/b95567800f828948baf5f4160ebb2473?s=40&d=identicon",
    "web_url" : "https://gitlab.example.com/jarrett"
623 624 625 626 627 628
  },
  "assignee": {
    "name": "Administrator",
    "username": "root",
    "id": 1,
    "state": "active",
629 630
    "avatar_url": "http://www.gravatar.com/avatar/e64c7d89f26bd1972efa854d13d7dd61?s=40&d=identicon",
    "web_url" : "https://gitlab.example.com/root"
631 632 633 634
  },
  "source_project_id": 4,
  "target_project_id": 4,
  "labels": [ ],
635 636
  "description": "Qui voluptatibus placeat ipsa alias quasi. Deleniti rem ut sint. Optio velit qui distinctio.",
  "work_in_progress": false,
637 638 639 640 641 642 643 644 645 646 647
  "milestone": {
    "id": 5,
    "iid": 1,
    "project_id": 4,
    "title": "v2.0",
    "description": "Assumenda aut placeat expedita exercitationem labore sunt enim earum.",
    "state": "closed",
    "created_at": "2015-02-02T19:49:26.013Z",
    "updated_at": "2015-02-02T19:49:26.013Z",
    "due_date": null
  },
648
  "merge_when_pipeline_succeeds": true,
649
  "merge_status": "can_be_merged",
650
  "subscribed" : true,
651 652
  "sha": "8888888888888888888888888888888888888888",
  "merge_commit_sha": null,
653
  "user_notes_count": 1,
654
  "changes_count": "1",
655 656
  "should_remove_source_branch": true,
  "force_remove_source_branch": false,
657
  "squash": false,
658
  "web_url": "http://example.com/example/example/merge_requests/1",
659
  "discussion_locked": false,
660 661 662 663 664 665
  "time_stats": {
    "time_estimate": 0,
    "total_time_spent": 0,
    "human_time_estimate": null,
    "human_total_time_spent": null
  }
666
  "changes": [
667 668 669 670 671 672 673 674 675 676 677 678 679 680
    {
    "old_path": "VERSION",
    "new_path": "VERSION",
    "a_mode": "100644",
    "b_mode": "100644",
    "diff": "--- a/VERSION\ +++ b/VERSION\ @@ -1 +1 @@\ -1.9.7\ +1.9.8",
    "new_file": false,
    "renamed_file": false,
    "deleted_file": false
    }
  ]
}
```

681 682
## List MR pipelines

683 684
> [Introduced][ce-15454] in GitLab 10.5.0.

685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706
Get a list of merge request pipelines.

```
GET /projects/:id/merge_requests/:merge_request_iid/pipelines
```

Parameters:

- `id` (required) - The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user
- `merge_request_iid` (required) - The internal ID of the merge request

```json
[
  {
    "id": 77,
    "sha": "959e04d7c7a30600c894bd3c0cd0e1ce7f42c11d",
    "ref": "master",
    "status": "success"
  }
]
```

Valeriy Sizov's avatar
Valeriy Sizov committed
707 708
## Create MR

709
Creates a new merge request.
Valeriy Sizov's avatar
Valeriy Sizov committed
710
```
711
POST /projects/:id/merge_requests
Valeriy Sizov's avatar
Valeriy Sizov committed
712 713
```

714 715 716 717 718 719 720 721 722 723
| Attribute                  | Type    | Required | Description                                                                     |
| ---------                  | ----    | -------- | -----------                                                                     |
| `id`                       | integer/string  | yes      | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user |
| `source_branch`            | string  | yes      | The source branch                                                               |
| `target_branch`            | string  | yes      | The target branch                                                               |
| `title`                    | string  | yes      | Title of MR                                                                     |
| `assignee_id`              | integer | no       | Assignee user ID                                                                |
| `description`              | string  | no       | Description of MR                                                               |
| `target_project_id`        | integer | no       | The target project (numeric id)                                                 |
| `labels`                   | string  | no       | Labels for MR as a comma-separated list                                         |
724
| `milestone_id`             | integer | no       | The global ID of a milestone                                                           |
725
| `remove_source_branch`     | boolean | no       | Flag indicating if a merge request should remove the source branch when merging |
726 727
| `allow_collaboration`      | boolean | no       | Allow commits from members who can merge to the target branch                   |
| `allow_maintainer_to_push` | boolean | no       | Deprecated, see allow_collaboration                                             |
728
| `squash`                   | boolean | no       | Squash commits into a single commit when merging                                |
Valeriy Sizov's avatar
Valeriy Sizov committed
729 730 731

```json
{
Johannes Schleifenbaum's avatar
Johannes Schleifenbaum committed
732
  "id": 1,
733
  "iid": 1,
734
  "project_id": 3,
Johannes Schleifenbaum's avatar
Johannes Schleifenbaum committed
735
  "title": "test1",
736
  "description": "fixed login page css paddings",
737
  "state": "merged",
738 739 740 741
  "created_at": "2017-04-29T08:46:00Z",
  "updated_at": "2017-04-29T08:46:00Z",
  "target_branch": "master",
  "source_branch": "test1",
Johannes Schleifenbaum's avatar
Johannes Schleifenbaum committed
742 743 744 745 746
  "upvotes": 0,
  "downvotes": 0,
  "author": {
    "id": 1,
    "name": "Administrator",
747
    "username": "admin",
Johannes Schleifenbaum's avatar
Johannes Schleifenbaum committed
748
    "state": "active",
749 750
    "avatar_url": null,
    "web_url" : "https://gitlab.example.com/admin"
Johannes Schleifenbaum's avatar
Johannes Schleifenbaum committed
751 752 753 754
  },
  "assignee": {
    "id": 1,
    "name": "Administrator",
755
    "username": "admin",
Johannes Schleifenbaum's avatar
Johannes Schleifenbaum committed
756
    "state": "active",
757 758
    "avatar_url": null,
    "web_url" : "https://gitlab.example.com/admin"
759
  },
760 761 762 763 764 765
  "source_project_id": 2,
  "target_project_id": 3,
  "labels": [
    "Community contribution",
    "Manage"
  ],
766 767 768 769
  "work_in_progress": false,
  "milestone": {
    "id": 5,
    "iid": 1,
770
    "project_id": 3,
771 772 773 774 775
    "title": "v2.0",
    "description": "Assumenda aut placeat expedita exercitationem labore sunt enim earum.",
    "state": "closed",
    "created_at": "2015-02-02T19:49:26.013Z",
    "updated_at": "2015-02-02T19:49:26.013Z",
776 777 778
    "due_date": "2018-09-22",
    "start_date": "2018-08-08",
    "web_url": "https://gitlab.example.com/my-group/my-project/milestones/1"
779
  },
780
  "merge_when_pipeline_succeeds": true,
781
  "merge_status": "can_be_merged",
782
  "merge_error": null,
783 784
  "sha": "8888888888888888888888888888888888888888",
  "merge_commit_sha": null,
785 786
  "user_notes_count": 1,
  "discussion_locked": null,
787
  "should_remove_source_branch": true,
788
  "force_remove_source_branch": false,
789
  "allow_collaboration": false,
790
  "allow_maintainer_to_push": false,
791
  "web_url": "http://gitlab.example.com/my-group/my-project/merge_requests/1",
792 793 794 795 796
  "time_stats": {
    "time_estimate": 0,
    "total_time_spent": 0,
    "human_time_estimate": null,
    "human_total_time_spent": null
797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827
  },
  "squash": false,
  "subscribed": false,
  "changes_count": "1",
  "merged_by": {
    "id": 87854,
    "name": "Douwe Maan",
    "username": "DouweM",
    "state": "active",
    "avatar_url": "https://gitlab.example.com/uploads/-/system/user/avatar/87854/avatar.png",
    "web_url": "https://gitlab.com/DouweM"
  },
  "merged_at": "2018-09-07T11:16:17.520Z",
  "closed_by": null,
  "closed_at": null,
  "latest_build_started_at": "2018-09-07T07:27:38.472Z",
  "latest_build_finished_at": "2018-09-07T08:07:06.012Z",
  "first_deployed_to_production_at": null,
  "pipeline": {
    "id": 29626725,
    "sha": "2be7ddb704c7b6b83732fdd5b9f09d5a397b5f8f",
    "ref": "patch-28",
    "status": "success",
    "web_url": "https://gitlab.example.com/my-group/my-project/pipelines/29626725"
  },
  "diff_refs": {
    "base_sha": "c380d3acebd181f13629a25d2e2acca46ffe1e00",
    "head_sha": "2be7ddb704c7b6b83732fdd5b9f09d5a397b5f8f",
    "start_sha": "c380d3acebd181f13629a25d2e2acca46ffe1e00"
  },
  "diverged_commits_count": 2
Valeriy Sizov's avatar
Valeriy Sizov committed
828 829 830 831 832
}
```

## Update MR

833
Updates an existing merge request. You can change the target branch, title, or even close the MR.
Valeriy Sizov's avatar
Valeriy Sizov committed
834 835

```
836
PUT /projects/:id/merge_requests/:merge_request_iid
Valeriy Sizov's avatar
Valeriy Sizov committed
837 838
```

839 840 841 842 843 844 845
| Attribute                  | Type    | Required | Description                                                                     |
| ---------                  | ----    | -------- | -----------                                                                     |
| `id`                       | integer/string | yes  | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user |
| `merge_request_iid`        | integer | yes      | The ID of a merge request                                                       |
| `target_branch`            | string  | no       | The target branch                                                               |
| `title`                    | string  | no       | Title of MR                                                                     |
| `assignee_id`              | integer | no       | The ID of the user to assign the merge request to. Set to `0` or provide an empty value to unassign all assignees.  |
846
| `milestone_id`             | integer | no       | The global ID of a milestone to assign the merge request to. Set to `0` or provide an empty value to unassign a milestone.|
847 848 849 850
| `labels`                   | string  | no       | Comma-separated label names for a merge request. Set to an empty string to unassign all labels.                    |
| `description`              | string  | no       | Description of MR                                                               |
| `state_event`              | string  | no       | New state (close/reopen)                                                        |
| `remove_source_branch`     | boolean | no       | Flag indicating if a merge request should remove the source branch when merging |
851
| `squash`                   | boolean | no       | Squash commits into a single commit when merging |
852
| `discussion_locked`        | boolean | no       | Flag indicating if the merge request's discussion is locked. If the discussion is locked only project members can add, edit or resolve comments. |
853 854
| `allow_collaboration`      | boolean | no       | Allow commits from members who can merge to the target branch                   |
| `allow_maintainer_to_push` | boolean | no       | Deprecated, see allow_collaboration                                             |
Valeriy Sizov's avatar
Valeriy Sizov committed
855

856 857
Must include at least one non-required attribute from above.

Valeriy Sizov's avatar
Valeriy Sizov committed
858 859
```json
{
Johannes Schleifenbaum's avatar
Johannes Schleifenbaum committed
860
  "id": 1,
861
  "iid": 1,
862
  "project_id": 3,
Johannes Schleifenbaum's avatar
Johannes Schleifenbaum committed
863
  "title": "test1",
864
  "description": "fixed login page css paddings",
865
  "state": "merged",
866 867 868 869
  "created_at": "2017-04-29T08:46:00Z",
  "updated_at": "2017-04-29T08:46:00Z",
  "target_branch": "master",
  "source_branch": "test1",
Johannes Schleifenbaum's avatar
Johannes Schleifenbaum committed
870 871 872 873 874
  "upvotes": 0,
  "downvotes": 0,
  "author": {
    "id": 1,
    "name": "Administrator",
875
    "username": "admin",
Johannes Schleifenbaum's avatar
Johannes Schleifenbaum committed
876
    "state": "active",
877 878
    "avatar_url": null,
    "web_url" : "https://gitlab.example.com/admin"
Johannes Schleifenbaum's avatar
Johannes Schleifenbaum committed
879 880 881 882
  },
  "assignee": {
    "id": 1,
    "name": "Administrator",
883
    "username": "admin",
Johannes Schleifenbaum's avatar
Johannes Schleifenbaum committed
884
    "state": "active",
885 886
    "avatar_url": null,
    "web_url" : "https://gitlab.example.com/admin"
887
  },
888 889 890 891 892 893
  "source_project_id": 2,
  "target_project_id": 3,
  "labels": [
    "Community contribution",
    "Manage"
  ],
894 895 896 897
  "work_in_progress": false,
  "milestone": {
    "id": 5,
    "iid": 1,
898
    "project_id": 3,
899 900 901 902 903
    "title": "v2.0",
    "description": "Assumenda aut placeat expedita exercitationem labore sunt enim earum.",
    "state": "closed",
    "created_at": "2015-02-02T19:49:26.013Z",
    "updated_at": "2015-02-02T19:49:26.013Z",
904 905 906
    "due_date": "2018-09-22",
    "start_date": "2018-08-08",
    "web_url": "https://gitlab.example.com/my-group/my-project/milestones/1"
907
  },
908
  "merge_when_pipeline_succeeds": true,
909
  "merge_status": "can_be_merged",
910
  "merge_error": null,
911 912
  "sha": "8888888888888888888888888888888888888888",
  "merge_commit_sha": null,
913
  "user_notes_count": 1,
914
  "discussion_locked": null,
915
  "should_remove_source_branch": true,
916
  "force_remove_source_branch": false,
917
  "allow_collaboration": false,
918
  "allow_maintainer_to_push": false,
919
  "web_url": "http://gitlab.example.com/my-group/my-project/merge_requests/1",
920 921 922 923 924
  "time_stats": {
    "time_estimate": 0,
    "total_time_spent": 0,
    "human_time_estimate": null,
    "human_total_time_spent": null
925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955
  },
  "squash": false,
  "subscribed": false,
  "changes_count": "1",
  "merged_by": {
    "id": 87854,
    "name": "Douwe Maan",
    "username": "DouweM",
    "state": "active",
    "avatar_url": "https://gitlab.example.com/uploads/-/system/user/avatar/87854/avatar.png",
    "web_url": "https://gitlab.com/DouweM"
  },
  "merged_at": "2018-09-07T11:16:17.520Z",
  "closed_by": null,
  "closed_at": null,
  "latest_build_started_at": "2018-09-07T07:27:38.472Z",
  "latest_build_finished_at": "2018-09-07T08:07:06.012Z",
  "first_deployed_to_production_at": null,
  "pipeline": {
    "id": 29626725,
    "sha": "2be7ddb704c7b6b83732fdd5b9f09d5a397b5f8f",
    "ref": "patch-28",
    "status": "success",
    "web_url": "https://gitlab.example.com/my-group/my-project/pipelines/29626725"
  },
  "diff_refs": {
    "base_sha": "c380d3acebd181f13629a25d2e2acca46ffe1e00",
    "head_sha": "2be7ddb704c7b6b83732fdd5b9f09d5a397b5f8f",
    "start_sha": "c380d3acebd181f13629a25d2e2acca46ffe1e00"
  },
  "diverged_commits_count": 2
Valeriy Sizov's avatar
Valeriy Sizov committed
956 957
}
```
958

959 960 961
## Delete a merge request

Only for admins and project owners. Soft deletes the merge request in question.
Zeger-Jan van de Weg's avatar
Zeger-Jan van de Weg committed
962 963

```
964
DELETE /projects/:id/merge_requests/:merge_request_iid
Zeger-Jan van de Weg's avatar
Zeger-Jan van de Weg committed
965 966
```

967 968 969
| Attribute | Type    | Required | Description                          |
| --------- | ----    | -------- | -----------                          |
| `id`      | integer/string  | yes      | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user |
970
| `merge_request_iid` | integer | yes      | The internal ID of the merge request |
Zeger-Jan van de Weg's avatar
Zeger-Jan van de Weg committed
971

972
```bash
973
curl --request DELETE --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/projects/4/merge_requests/85
Zeger-Jan van de Weg's avatar
Zeger-Jan van de Weg committed
974 975
```

Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
976 977
## Accept MR

978
Merge changes submitted with MR using this API.
979

980
If merge request is unable to be accepted (ie: Work in Progress, Closed, Pipeline Pending Completion, or Failed while requiring Success) - you'll get a `405` and the error message 'Method Not Allowed'
981

982
If it has some conflicts and can not be merged - you'll get a `406` and the error message 'Branch cannot be merged'
983

984
If the `sha` parameter is passed and does not match the HEAD of the source - you'll get a `409` and the error message 'SHA does not match HEAD of source branch'
985

986
If you don't have permissions to accept this merge request - you'll get a `401`
Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
987 988

```
989
PUT /projects/:id/merge_requests/:merge_request_iid/merge
Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
990 991 992 993
```

Parameters:

994
- `id` (required) - The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user
995
- `merge_request_iid` (required)            - Internal ID of MR
996
- `merge_commit_message` (optional)         - Custom merge commit message
997 998
- `squash_commit_message` (optional)        - Custom squash commit message
- `squash` (optional)                       - if `true` the commits will be squashed into a single commit on merge
999
- `should_remove_source_branch` (optional)  - if `true` removes the source branch
1000
- `merge_when_pipeline_succeeds` (optional) - if `true` the MR is merged when the pipeline succeeds
1001
- `sha` (optional)                          - if present, then this SHA must match the HEAD of the source branch, otherwise the merge will fail
1002 1003 1004 1005

```json
{
  "id": 1,
1006
  "iid": 1,
1007 1008
  "project_id": 3,
  "title": "test1",
1009
  "description": "fixed login page css paddings",
1010
  "state": "merged",
1011 1012 1013 1014
  "created_at": "2017-04-29T08:46:00Z",
  "updated_at": "2017-04-29T08:46:00Z",
  "target_branch": "master",
  "source_branch": "test1",
1015 1016 1017 1018 1019
  "upvotes": 0,
  "downvotes": 0,
  "author": {
    "id": 1,
    "name": "Administrator",
1020
    "username": "admin",
1021
    "state": "active",
1022 1023
    "avatar_url": null,
    "web_url" : "https://gitlab.example.com/admin"
1024 1025 1026 1027
  },
  "assignee": {
    "id": 1,
    "name": "Administrator",
1028
    "username": "admin",
1029
    "state": "active",
1030 1031
    "avatar_url": null,
    "web_url" : "https://gitlab.example.com/admin"
1032
  },
1033 1034 1035 1036 1037 1038
  "source_project_id": 2,
  "target_project_id": 3,
  "labels": [
    "Community contribution",
    "Manage"
  ],
1039 1040 1041 1042
  "work_in_progress": false,
  "milestone": {
    "id": 5,
    "iid": 1,
1043
    "project_id": 3,
1044 1045 1046 1047 1048
    "title": "v2.0",
    "description": "Assumenda aut placeat expedita exercitationem labore sunt enim earum.",
    "state": "closed",
    "created_at": "2015-02-02T19:49:26.013Z",
    "updated_at": "2015-02-02T19:49:26.013Z",
1049 1050 1051
    "due_date": "2018-09-22",
    "start_date": "2018-08-08",
    "web_url": "https://gitlab.example.com/my-group/my-project/milestones/1"
1052
  },
1053
  "merge_when_pipeline_succeeds": true,
1054
  "merge_status": "can_be_merged",
1055
  "merge_error": null,
1056
  "sha": "8888888888888888888888888888888888888888",
1057
  "merge_commit_sha": null,
1058
  "user_notes_count": 1,
1059
  "discussion_locked": null,
1060
  "should_remove_source_branch": true,
1061
  "force_remove_source_branch": false,
1062 1063 1064
  "allow_collaboration": false,
  "allow_maintainer_to_push": false,
  "web_url": "http://gitlab.example.com/my-group/my-project/merge_requests/1",
1065 1066 1067 1068 1069
  "time_stats": {
    "time_estimate": 0,
    "total_time_spent": 0,
    "human_time_estimate": null,
    "human_total_time_spent": null
1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100
  },
  "squash": false,
  "subscribed": false,
  "changes_count": "1",
  "merged_by": {
    "id": 87854,
    "name": "Douwe Maan",
    "username": "DouweM",
    "state": "active",
    "avatar_url": "https://gitlab.example.com/uploads/-/system/user/avatar/87854/avatar.png",
    "web_url": "https://gitlab.com/DouweM"
  },
  "merged_at": "2018-09-07T11:16:17.520Z",
  "closed_by": null,
  "closed_at": null,
  "latest_build_started_at": "2018-09-07T07:27:38.472Z",
  "latest_build_finished_at": "2018-09-07T08:07:06.012Z",
  "first_deployed_to_production_at": null,
  "pipeline": {
    "id": 29626725,
    "sha": "2be7ddb704c7b6b83732fdd5b9f09d5a397b5f8f",
    "ref": "patch-28",
    "status": "success",
    "web_url": "https://gitlab.example.com/my-group/my-project/pipelines/29626725"
  },
  "diff_refs": {
    "base_sha": "c380d3acebd181f13629a25d2e2acca46ffe1e00",
    "head_sha": "2be7ddb704c7b6b83732fdd5b9f09d5a397b5f8f",
    "start_sha": "c380d3acebd181f13629a25d2e2acca46ffe1e00"
  },
  "diverged_commits_count": 2
1101 1102 1103
}
```

1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137
## Merge to default merge ref path

Merge the changes between the merge request source and target branches into `refs/merge-requests/:iid/merge` 
ref, of the target project repository. This ref will have the state the target branch would have if
a regular merge action was taken.

This is not a regular merge action given it doesn't change the merge request state in any manner.

This ref (`refs/merge-requests/:iid/merge`) is **always** overwritten when submitting
requests to this API, so none of its state is kept or used in the process.

If the merge request has conflicts, is empty or already merged,
you'll get a `400` and a descriptive error message. If you don't have permissions to do so, 
you'll get a `403`.

It returns the HEAD commit of `refs/merge-requests/:iid/merge` in the response body in
case of `200`.

```
PUT /projects/:id/merge_requests/:merge_request_iid/merge_to_ref
```

Parameters:

- `id` (required) - The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user
- `merge_request_iid` (required)            - Internal ID of MR
- `merge_commit_message` (optional)         - Custom merge commit message

```json
{
  "commit_id": "854a3a7a17acbcc0bbbea170986df1eb60435f34"
}
```

1138
## Cancel Merge When Pipeline Succeeds
1139

1140
If you don't have permissions to accept this merge request - you'll get a `401`
1141

1142
If the merge request is already merged or closed - you get `405` and error message 'Method Not Allowed'
1143

1144
In case the merge request is not set to be merged when the pipeline succeeds, you'll also get a `406` error.
1145
```
1146
PUT /projects/:id/merge_requests/:merge_request_iid/cancel_merge_when_pipeline_succeeds
1147 1148 1149
```
Parameters:

1150
- `id` (required) - The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user
1151
- `merge_request_iid` (required) - Internal ID of MR
Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
1152 1153 1154 1155

```json
{
  "id": 1,
1156
  "iid": 1,
Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
1157 1158
  "project_id": 3,
  "title": "test1",
1159
  "description": "fixed login page css paddings",
1160
  "state": "merged",
1161 1162 1163 1164
  "created_at": "2017-04-29T08:46:00Z",
  "updated_at": "2017-04-29T08:46:00Z",
  "target_branch": "master",
  "source_branch": "test1",
Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
1165 1166 1167 1168 1169
  "upvotes": 0,
  "downvotes": 0,
  "author": {
    "id": 1,
    "name": "Administrator",
1170
    "username": "admin",
Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
1171
    "state": "active",
1172 1173
    "avatar_url": null,
    "web_url" : "https://gitlab.example.com/admin"
Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
1174 1175 1176 1177
  },
  "assignee": {
    "id": 1,
    "name": "Administrator",
1178
    "username": "admin",
Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
1179
    "state": "active",
1180 1181
    "avatar_url": null,
    "web_url" : "https://gitlab.example.com/admin"
1182
  },