merge_requests.md 42.4 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 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96
Get all merge requests the authenticated user has access to.
The `state` parameter can be used to get only merge requests with a
given state (`opened`, `closed`, or `merged`) or all of them (`all`).
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
GET /merge_requests?scope=assigned-to-me
```

Parameters:

| Attribute | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `state`   | string  | no    | Return all merge requests or just those that are `opened`, `closed`, or `merged`|
| `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`  |
| `milestone`  | string  | no | Return merge requests for a specific milestone |
| `view` | string | no | If `simple`, returns the `iid`, URL, title, description, and basic state of merge request |
| `labels`  | string  | no | Return merge requests matching a comma separated list of labels |
| `created_after` | datetime | no | Return merge requests created after the given time (inclusive) |
| `created_before` | datetime | no | Return merge requests created before the given time (inclusive) |
| `author_id` | integer | no | Returns merge requests created by the given user `id` |
| `assignee_id` | integer | no | Returns merge requests assigned to the given user `id` |
| `scope` | string | no | Return merge requests for the given scope: `created-by-me`, `assigned-to-me` or `all` |

```json
[
  {
    "id": 1,
    "iid": 1,
    "target_branch": "master",
    "source_branch": "test1",
    "project_id": 3,
    "title": "test1",
    "state": "opened",
    "upvotes": 0,
    "downvotes": 0,
    "author": {
      "id": 1,
      "username": "admin",
      "email": "admin@example.com",
      "name": "Administrator",
      "state": "active",
      "created_at": "2012-04-29T08:46:00Z"
    },
    "assignee": {
      "id": 1,
      "username": "admin",
      "email": "admin@example.com",
      "name": "Administrator",
      "state": "active",
      "created_at": "2012-04-29T08:46:00Z"
    },
    "source_project_id": 2,
    "target_project_id": 3,
    "labels": [ ],
    "description": "fixed login page css paddings",
    "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",
      "due_date": null
    },
    "merge_when_pipeline_succeeds": true,
    "merge_status": "can_be_merged",
    "sha": "8888888888888888888888888888888888888888",
    "merge_commit_sha": null,
    "user_notes_count": 1,
    "should_remove_source_branch": true,
    "force_remove_source_branch": false,
    "web_url": "http://example.com/example/example/merge_requests/1"
  }
]
```

## List project merge requests

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

```
102
GET /projects/:id/merge_requests
103 104
GET /projects/:id/merge_requests?state=opened
GET /projects/:id/merge_requests?state=all
105
GET /projects/:id/merge_requests?iids[]=42&iids[]=43
106
GET /projects/:id/merge_requests?milestone=release
107
GET /projects/:id/merge_requests?labels=bug,reproduced
Valeriy Sizov's avatar
Valeriy Sizov committed
108 109 110 111
```

Parameters:

112 113 114 115 116 117 118 119
| Attribute | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `id` | integer | yes | The ID of a project |
| `iids` | Array[integer] | no | Return the request having the given `iid` |
| `state`   | string  | no    | Return all merge requests or just those that are `opened`, `closed`, or `merged`|
| `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`  |
| `milestone`  | string  | no | Return merge requests for a specific milestone |
120
| `view` | string | no | If `simple`, returns the `iid`, URL, title, description, and basic state of merge request |
121
| `labels`  | string  | no | Return merge requests matching a comma separated list of labels |
122 123
| `created_after` | datetime | no | Return merge requests created after the given time (inclusive) |
| `created_before` | datetime | no | Return merge requests created before the given time (inclusive) |
Valeriy Sizov's avatar
Valeriy Sizov committed
124 125 126

```json
[
Johannes Schleifenbaum's avatar
Johannes Schleifenbaum committed
127 128 129 130 131 132 133 134 135 136 137 138 139
  {
    "id": 1,
    "iid": 1,
    "target_branch": "master",
    "source_branch": "test1",
    "project_id": 3,
    "title": "test1",
    "state": "opened",
    "upvotes": 0,
    "downvotes": 0,
    "author": {
      "id": 1,
      "username": "admin",
140
      "email": "admin@example.com",
Johannes Schleifenbaum's avatar
Johannes Schleifenbaum committed
141 142 143 144 145 146 147
      "name": "Administrator",
      "state": "active",
      "created_at": "2012-04-29T08:46:00Z"
    },
    "assignee": {
      "id": 1,
      "username": "admin",
148
      "email": "admin@example.com",
Johannes Schleifenbaum's avatar
Johannes Schleifenbaum committed
149 150 151
      "name": "Administrator",
      "state": "active",
      "created_at": "2012-04-29T08:46:00Z"
152
    },
Ben Boeckel's avatar
Ben Boeckel committed
153 154
    "source_project_id": 2,
    "target_project_id": 3,
155
    "labels": [ ],
Ben Boeckel's avatar
Ben Boeckel committed
156
    "description": "fixed login page css paddings",
157 158 159 160 161 162 163 164 165 166 167 168
    "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",
      "due_date": null
    },
169
    "merge_when_pipeline_succeeds": true,
170
    "merge_status": "can_be_merged",
171 172
    "sha": "8888888888888888888888888888888888888888",
    "merge_commit_sha": null,
173 174
    "user_notes_count": 1,
    "should_remove_source_branch": true,
175 176
    "force_remove_source_branch": false,
    "web_url": "http://example.com/example/example/merge_requests/1"
Johannes Schleifenbaum's avatar
Johannes Schleifenbaum committed
177
  }
Valeriy Sizov's avatar
Valeriy Sizov committed
178 179 180
]
```

181 182
## Get single MR

183
Shows information about a single merge request.
Valeriy Sizov's avatar
Valeriy Sizov committed
184 185

```
186
GET /projects/:id/merge_requests/:merge_request_iid
Valeriy Sizov's avatar
Valeriy Sizov committed
187 188 189 190
```

Parameters:

191
- `id` (required) - The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user
192
- `merge_request_iid` (required) - The internal ID of the merge request
Valeriy Sizov's avatar
Valeriy Sizov committed
193 194 195

```json
{
Johannes Schleifenbaum's avatar
Johannes Schleifenbaum committed
196 197 198 199 200 201 202 203 204 205 206 207
  "id": 1,
  "iid": 1,
  "target_branch": "master",
  "source_branch": "test1",
  "project_id": 3,
  "title": "test1",
  "state": "merged",
  "upvotes": 0,
  "downvotes": 0,
  "author": {
    "id": 1,
    "username": "admin",
208
    "email": "admin@example.com",
Johannes Schleifenbaum's avatar
Johannes Schleifenbaum committed
209 210 211 212 213 214 215
    "name": "Administrator",
    "state": "active",
    "created_at": "2012-04-29T08:46:00Z"
  },
  "assignee": {
    "id": 1,
    "username": "admin",
216
    "email": "admin@example.com",
Johannes Schleifenbaum's avatar
Johannes Schleifenbaum committed
217 218 219
    "name": "Administrator",
    "state": "active",
    "created_at": "2012-04-29T08:46:00Z"
220
  },
Ben Boeckel's avatar
Ben Boeckel committed
221 222
  "source_project_id": 2,
  "target_project_id": 3,
223
  "labels": [ ],
Ben Boeckel's avatar
Ben Boeckel committed
224
  "description": "fixed login page css paddings",
225 226 227 228 229 230 231 232 233 234 235 236
  "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",
    "due_date": null
  },
237
  "merge_when_pipeline_succeeds": true,
238
  "merge_status": "can_be_merged",
239
  "subscribed" : true,
240 241
  "sha": "8888888888888888888888888888888888888888",
  "merge_commit_sha": "9999999999999999999999999999999999999999",
242 243
  "user_notes_count": 1,
  "should_remove_source_branch": true,
244 245
  "force_remove_source_branch": false,
  "web_url": "http://example.com/example/example/merge_requests/1"
Valeriy Sizov's avatar
Valeriy Sizov committed
246 247 248
}
```

249 250
## Get single MR commits

Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
251
Get a list of merge request commits.
252 253

```
254
GET /projects/:id/merge_requests/:merge_request_iid/commits
255 256 257 258
```

Parameters:

259
- `id` (required) - The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user
260
- `merge_request_iid` (required) - The internal ID of the merge request
261 262 263 264 265 266 267 268 269 270 271


```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
272
    "message": "Replace sanitize with escape once"
273 274 275 276 277 278 279 280
  },
  {
    "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
281
    "message": "Sanitize for network graph"
282 283 284 285
  }
]
```

286 287
## Get single MR changes

288
Shows information about the merge request including its files and changes.
289 290

```
291
GET /projects/:id/merge_requests/:merge_request_iid/changes
292 293 294 295
```

Parameters:

296
- `id` (required) - The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user
297
- `merge_request_iid` (required) - The internal ID of the merge request
298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328

```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",
    "avatar_url": "http://www.gravatar.com/avatar/b95567800f828948baf5f4160ebb2473?s=40&d=identicon"
  },
  "assignee": {
    "name": "Administrator",
    "username": "root",
    "id": 1,
    "state": "active",
    "avatar_url": "http://www.gravatar.com/avatar/e64c7d89f26bd1972efa854d13d7dd61?s=40&d=identicon"
  },
  "source_project_id": 4,
  "target_project_id": 4,
  "labels": [ ],
329 330
  "description": "Qui voluptatibus placeat ipsa alias quasi. Deleniti rem ut sint. Optio velit qui distinctio.",
  "work_in_progress": false,
331 332 333 334 335 336 337 338 339 340 341
  "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
  },
342
  "merge_when_pipeline_succeeds": true,
343
  "merge_status": "can_be_merged",
344
  "subscribed" : true,
345 346
  "sha": "8888888888888888888888888888888888888888",
  "merge_commit_sha": null,
347
  "user_notes_count": 1,
348 349
  "should_remove_source_branch": true,
  "force_remove_source_branch": false,
350
  "web_url": "http://example.com/example/example/merge_requests/1",
351
  "changes": [
352 353 354 355 356 357 358 359 360 361 362 363 364 365
    {
    "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
    }
  ]
}
```

Valeriy Sizov's avatar
Valeriy Sizov committed
366 367
## Create MR

368
Creates a new merge request.
Valeriy Sizov's avatar
Valeriy Sizov committed
369
```
370
POST /projects/:id/merge_requests
Valeriy Sizov's avatar
Valeriy Sizov committed
371 372
```

373 374
| Attribute              | Type    | Required | Description                                                                     |
| ---------              | ----    | -------- | -----------                                                                     |
375
| `id`                   | integer/string  | yes      | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user |
376 377 378 379 380 381 382 383 384
| `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                                         |
| `milestone_id`         | integer | no       | The ID of a milestone                                                           |
| `remove_source_branch` | boolean | no       | Flag indicating if a merge request should remove the source branch when merging |
Valeriy Sizov's avatar
Valeriy Sizov committed
385 386 387

```json
{
Johannes Schleifenbaum's avatar
Johannes Schleifenbaum committed
388
  "id": 1,
389
  "iid": 1,
Johannes Schleifenbaum's avatar
Johannes Schleifenbaum committed
390 391 392 393 394 395 396 397 398 399
  "target_branch": "master",
  "source_branch": "test1",
  "project_id": 3,
  "title": "test1",
  "state": "opened",
  "upvotes": 0,
  "downvotes": 0,
  "author": {
    "id": 1,
    "username": "admin",
400
    "email": "admin@example.com",
Johannes Schleifenbaum's avatar
Johannes Schleifenbaum committed
401 402 403 404 405 406 407
    "name": "Administrator",
    "state": "active",
    "created_at": "2012-04-29T08:46:00Z"
  },
  "assignee": {
    "id": 1,
    "username": "admin",
408
    "email": "admin@example.com",
Johannes Schleifenbaum's avatar
Johannes Schleifenbaum committed
409 410 411
    "name": "Administrator",
    "state": "active",
    "created_at": "2012-04-29T08:46:00Z"
412
  },
413 414 415
  "source_project_id": 4,
  "target_project_id": 4,
  "labels": [ ],
Ben Boeckel's avatar
Ben Boeckel committed
416
  "description": "fixed login page css paddings",
417 418 419 420 421 422 423 424 425 426 427 428
  "work_in_progress": false,
  "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
  },
429
  "merge_when_pipeline_succeeds": true,
430
  "merge_status": "can_be_merged",
431
  "subscribed" : true,
432 433
  "sha": "8888888888888888888888888888888888888888",
  "merge_commit_sha": null,
434 435
  "user_notes_count": 0,
  "should_remove_source_branch": true,
436 437
  "force_remove_source_branch": false,
  "web_url": "http://example.com/example/example/merge_requests/1"
Valeriy Sizov's avatar
Valeriy Sizov committed
438 439 440 441 442
}
```

## Update MR

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

```
446
PUT /projects/:id/merge_requests/:merge_request_iid
Valeriy Sizov's avatar
Valeriy Sizov committed
447 448
```

449 450
| Attribute              | Type    | Required | Description                                                                     |
| ---------              | ----    | -------- | -----------                                                                     |
451
| `id`                   | integer/string  | yes      | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user |
452 453 454 455 456 457 458 459 460
| `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       | Assignee user ID                                                                |
| `description`          | string  | no       | Description of MR                                                               |
| `state_event`          | string  | no       | New state (close/reopen)                                                        |
| `labels`               | string  | no       | Labels for MR as a comma-separated list                                         |
| `milestone_id`         | integer | no       | The ID of a milestone                                                           |
| `remove_source_branch` | boolean | no       | Flag indicating if a merge request should remove the source branch when merging |
Valeriy Sizov's avatar
Valeriy Sizov committed
461

462 463
Must include at least one non-required attribute from above.

Valeriy Sizov's avatar
Valeriy Sizov committed
464 465
```json
{
Johannes Schleifenbaum's avatar
Johannes Schleifenbaum committed
466
  "id": 1,
467
  "iid": 1,
Johannes Schleifenbaum's avatar
Johannes Schleifenbaum committed
468 469 470 471 472 473 474 475 476
  "target_branch": "master",
  "project_id": 3,
  "title": "test1",
  "state": "opened",
  "upvotes": 0,
  "downvotes": 0,
  "author": {
    "id": 1,
    "username": "admin",
477
    "email": "admin@example.com",
Johannes Schleifenbaum's avatar
Johannes Schleifenbaum committed
478 479 480 481 482 483 484
    "name": "Administrator",
    "state": "active",
    "created_at": "2012-04-29T08:46:00Z"
  },
  "assignee": {
    "id": 1,
    "username": "admin",
485
    "email": "admin@example.com",
Johannes Schleifenbaum's avatar
Johannes Schleifenbaum committed
486 487 488
    "name": "Administrator",
    "state": "active",
    "created_at": "2012-04-29T08:46:00Z"
489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505
  },
  "source_project_id": 4,
  "target_project_id": 4,
  "labels": [ ],
  "description": "description1",
  "work_in_progress": false,
  "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
  },
506
  "merge_when_pipeline_succeeds": true,
507
  "merge_status": "can_be_merged",
508
  "subscribed" : true,
509 510
  "sha": "8888888888888888888888888888888888888888",
  "merge_commit_sha": null,
511 512
  "user_notes_count": 1,
  "should_remove_source_branch": true,
513 514
  "force_remove_source_branch": false,
  "web_url": "http://example.com/example/example/merge_requests/1"
Valeriy Sizov's avatar
Valeriy Sizov committed
515 516
}
```
517

518 519 520
## 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
521 522

```
523
DELETE /projects/:id/merge_requests/:merge_request_iid
Zeger-Jan van de Weg's avatar
Zeger-Jan van de Weg committed
524 525
```

526 527 528
| 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 |
529
| `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
530

531
```bash
532
curl --request DELETE --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" https://gitlab.example.com/api/v4/projects/4/merge_requests/85
Zeger-Jan van de Weg's avatar
Zeger-Jan van de Weg committed
533 534
```

Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
535 536
## Accept MR

537
Merge changes submitted with MR using this API.
538 539


540
If it has some conflicts and can not be merged - you'll get a `405` and the error message 'Branch cannot be merged'
541

542
If merge request is already merged or closed - you'll get a `406` and the error message 'Method Not Allowed'
543

544
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'
545

546
If you don't have permissions to accept this merge request - you'll get a `401`
Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
547 548

```
549
PUT /projects/:id/merge_requests/:merge_request_iid/merge
Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
550 551 552 553
```

Parameters:

554
- `id` (required) - The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user
555
- `merge_request_iid` (required)            - Internal ID of MR
556 557
- `merge_commit_message` (optional)         - Custom merge commit message
- `should_remove_source_branch` (optional)  - if `true` removes the source branch
558
- `merge_when_pipeline_succeeds` (optional)    - if `true` the MR is merged when the pipeline succeeds
559
- `sha` (optional)                          - if present, then this SHA must match the HEAD of the source branch, otherwise the merge will fail
560 561 562 563

```json
{
  "id": 1,
564
  "iid": 1,
565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586
  "target_branch": "master",
  "source_branch": "test1",
  "project_id": 3,
  "title": "test1",
  "state": "merged",
  "upvotes": 0,
  "downvotes": 0,
  "author": {
    "id": 1,
    "username": "admin",
    "email": "admin@example.com",
    "name": "Administrator",
    "state": "active",
    "created_at": "2012-04-29T08:46:00Z"
  },
  "assignee": {
    "id": 1,
    "username": "admin",
    "email": "admin@example.com",
    "name": "Administrator",
    "state": "active",
    "created_at": "2012-04-29T08:46:00Z"
587 588 589 590
  },
  "source_project_id": 4,
  "target_project_id": 4,
  "labels": [ ],
Ben Boeckel's avatar
Ben Boeckel committed
591
  "description": "fixed login page css paddings",
592 593 594 595 596 597 598 599 600 601 602 603
  "work_in_progress": false,
  "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
  },
604
  "merge_when_pipeline_succeeds": true,
605
  "merge_status": "can_be_merged",
606
  "subscribed" : true,
607 608
  "sha": "8888888888888888888888888888888888888888",
  "merge_commit_sha": "9999999999999999999999999999999999999999",
609 610
  "user_notes_count": 1,
  "should_remove_source_branch": true,
611 612
  "force_remove_source_branch": false,
  "web_url": "http://example.com/example/example/merge_requests/1"
613 614 615
}
```

616
## Cancel Merge When Pipeline Succeeds
617

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

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

622
In case the merge request is not set to be merged when the pipeline succeeds, you'll also get a `406` error.
623
```
624
PUT /projects/:id/merge_requests/:merge_request_iid/cancel_merge_when_pipeline_succeeds
625 626 627
```
Parameters:

628
- `id` (required) - The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user
629
- `merge_request_iid` (required)            - Internal ID of MR
Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
630 631 632 633

```json
{
  "id": 1,
634
  "iid": 1,
Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
635 636 637 638
  "target_branch": "master",
  "source_branch": "test1",
  "project_id": 3,
  "title": "test1",
639
  "state": "opened",
Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
640 641 642 643 644
  "upvotes": 0,
  "downvotes": 0,
  "author": {
    "id": 1,
    "username": "admin",
645
    "email": "admin@example.com",
Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
646 647 648 649 650 651 652
    "name": "Administrator",
    "state": "active",
    "created_at": "2012-04-29T08:46:00Z"
  },
  "assignee": {
    "id": 1,
    "username": "admin",
653
    "email": "admin@example.com",
Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
654 655 656
    "name": "Administrator",
    "state": "active",
    "created_at": "2012-04-29T08:46:00Z"
657 658 659 660
  },
  "source_project_id": 4,
  "target_project_id": 4,
  "labels": [ ],
Ben Boeckel's avatar
Ben Boeckel committed
661
  "description": "fixed login page css paddings",
662 663 664 665 666 667 668 669 670 671 672 673
  "work_in_progress": false,
  "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
  },
674
  "merge_when_pipeline_succeeds": true,
675
  "merge_status": "can_be_merged",
676
  "subscribed" : true,
677 678
  "sha": "8888888888888888888888888888888888888888",
  "merge_commit_sha": null,
679 680
  "user_notes_count": 1,
  "should_remove_source_branch": true,
681 682
  "force_remove_source_branch": false,
  "web_url": "http://example.com/example/example/merge_requests/1"
Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
683 684 685
}
```

bb-froggy's avatar
typo  
bb-froggy committed
686
## Comments on merge requests
687

688
Comments are done via the [notes](notes.md) resource.
689 690 691 692 693 694

## List issues that will close on merge

Get all the issues that would be closed by merging the provided merge request.

```
695
GET /projects/:id/merge_requests/:merge_request_iid/closes_issues
696 697
```

698 699
| Attribute           | Type    | Required | Description                          |
| ---------           | ----    | -------- | -----------                          |
700
| `id`                | integer/string | yes      | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user                  |
701
| `merge_request_iid` | integer | yes      | The internal ID of the merge request |
702 703

```bash
704
curl --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" https://gitlab.example.com/api/v4/projects/76/merge_requests/1/closes_issues
705 706
```

707
Example response when the GitLab issue tracker is used:
708 709 710 711 712 713 714 715 716

```json
[
   {
      "state" : "opened",
      "description" : "Ratione dolores corrupti mollitia soluta quia.",
      "author" : {
         "state" : "active",
         "id" : 18,
717
         "web_url" : "https://gitlab.example.com/eileen.lowe",
718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737
         "name" : "Alexandra Bashirian",
         "avatar_url" : null,
         "username" : "eileen.lowe"
      },
      "milestone" : {
         "project_id" : 1,
         "description" : "Ducimus nam enim ex consequatur cumque ratione.",
         "state" : "closed",
         "due_date" : null,
         "iid" : 2,
         "created_at" : "2016-01-04T15:31:39.996Z",
         "title" : "v4.0",
         "id" : 17,
         "updated_at" : "2016-01-04T15:31:39.996Z"
      },
      "project_id" : 1,
      "assignee" : {
         "state" : "active",
         "id" : 1,
         "name" : "Administrator",
738
         "web_url" : "https://gitlab.example.com/root",
739 740 741 742 743 744 745 746
         "avatar_url" : null,
         "username" : "root"
      },
      "updated_at" : "2016-01-04T15:31:51.081Z",
      "id" : 76,
      "title" : "Consequatur vero maxime deserunt laboriosam est voluptas dolorem.",
      "created_at" : "2016-01-04T15:31:51.081Z",
      "iid" : 6,
747 748
      "labels" : [],
      "user_notes_count": 1
749 750 751
   },
]
```
752

753 754 755 756 757 758 759 760 761 762 763
Example response when an external issue tracker (e.g. JIRA) is used:

```json
[
   {
       "id" : "PROJECT-123",
       "title" : "Title of this issue"
   }
]
```

764 765
## Subscribe to a merge request

766 767
Subscribes the authenticated user to a merge request to receive notification. If the user is already subscribed to the merge request, the
status code `304` is returned.
768 769

```
770
POST /projects/:id/merge_requests/:merge_request_iid/subscribe
771 772
```

773 774
| Attribute           | Type    | Required | Description                 |
| ---------           | ----    | -------- | -----------                 |
775
| `id`                | integer/string | yes      | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user         |
776
| `merge_request_iid` | integer | yes      | The internal ID of the merge request |
777 778

```bash
779
curl --request POST --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" https://gitlab.example.com/api/v4/projects/5/merge_requests/17/subscribe
780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803
```

Example response:

```json
{
  "id": 17,
  "iid": 1,
  "project_id": 5,
  "title": "Et et sequi est impedit nulla ut rem et voluptatem.",
  "description": "Consequatur velit eos rerum optio autem. Quia id officia quaerat dolorum optio. Illo laudantium aut ipsum dolorem.",
  "state": "opened",
  "created_at": "2016-04-05T21:42:23.233Z",
  "updated_at": "2016-04-05T22:11:52.900Z",
  "target_branch": "ui-dev-kit",
  "source_branch": "version-1-9",
  "upvotes": 0,
  "downvotes": 0,
  "author": {
    "name": "Eileen Skiles",
    "username": "leila",
    "id": 19,
    "state": "active",
    "avatar_url": "http://www.gravatar.com/avatar/39ce4a2822cc896933ffbd68c1470e55?s=80&d=identicon",
804
    "web_url": "https://gitlab.example.com/leila"
805 806 807 808 809 810 811
  },
  "assignee": {
    "name": "Celine Wehner",
    "username": "carli",
    "id": 16,
    "state": "active",
    "avatar_url": "http://www.gravatar.com/avatar/f4cd5605b769dd2ce405a27c6e6f2684?s=80&d=identicon",
812
    "web_url": "https://gitlab.example.com/carli"
813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828
  },
  "source_project_id": 5,
  "target_project_id": 5,
  "labels": [],
  "work_in_progress": false,
  "milestone": {
    "id": 7,
    "iid": 1,
    "project_id": 5,
    "title": "v2.0",
    "description": "Corrupti eveniet et velit occaecati dolorem est rerum aut.",
    "state": "closed",
    "created_at": "2016-04-05T21:41:40.905Z",
    "updated_at": "2016-04-05T21:41:40.905Z",
    "due_date": null
  },
829
  "merge_when_pipeline_succeeds": false,
830
  "merge_status": "cannot_be_merged",
831 832 833
  "subscribed": true,
  "sha": "8888888888888888888888888888888888888888",
  "merge_commit_sha": null
834 835
}
```
836

837 838
## Unsubscribe from a merge request

839
Unsubscribes the authenticated user from a merge request to not receive
840 841
notifications from that merge request. If the user is
not subscribed to the merge request, the status code `304` is returned.
842 843

```
844
POST /projects/:id/merge_requests/:merge_request_iid/unsubscribe
845 846
```

847 848
| Attribute           | Type    | Required | Description                          |
| ---------           | ----    | -------- | -----------                          |
849
| `id`                | integer/string | yes      | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user                  |
850
| `merge_request_iid` | integer | yes      | The internal ID of the merge request |
851 852

```bash
853
curl --request POST --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" https://gitlab.example.com/api/v4/projects/5/merge_requests/17/unsubscribe
854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877
```

Example response:

```json
{
  "id": 17,
  "iid": 1,
  "project_id": 5,
  "title": "Et et sequi est impedit nulla ut rem et voluptatem.",
  "description": "Consequatur velit eos rerum optio autem. Quia id officia quaerat dolorum optio. Illo laudantium aut ipsum dolorem.",
  "state": "opened",
  "created_at": "2016-04-05T21:42:23.233Z",
  "updated_at": "2016-04-05T22:11:52.900Z",
  "target_branch": "ui-dev-kit",
  "source_branch": "version-1-9",
  "upvotes": 0,
  "downvotes": 0,
  "author": {
    "name": "Eileen Skiles",
    "username": "leila",
    "id": 19,
    "state": "active",
    "avatar_url": "http://www.gravatar.com/avatar/39ce4a2822cc896933ffbd68c1470e55?s=80&d=identicon",
878
    "web_url": "https://gitlab.example.com/leila"
879 880 881 882 883 884 885
  },
  "assignee": {
    "name": "Celine Wehner",
    "username": "carli",
    "id": 16,
    "state": "active",
    "avatar_url": "http://www.gravatar.com/avatar/f4cd5605b769dd2ce405a27c6e6f2684?s=80&d=identicon",
886
    "web_url": "https://gitlab.example.com/carli"
887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902
  },
  "source_project_id": 5,
  "target_project_id": 5,
  "labels": [],
  "work_in_progress": false,
  "milestone": {
    "id": 7,
    "iid": 1,
    "project_id": 5,
    "title": "v2.0",
    "description": "Corrupti eveniet et velit occaecati dolorem est rerum aut.",
    "state": "closed",
    "created_at": "2016-04-05T21:41:40.905Z",
    "updated_at": "2016-04-05T21:41:40.905Z",
    "due_date": null
  },
903
  "merge_when_pipeline_succeeds": false,
904
  "merge_status": "cannot_be_merged",
905 906 907
  "subscribed": false,
  "sha": "8888888888888888888888888888888888888888",
  "merge_commit_sha": null
908 909
}
```
910 911 912

## Create a todo

913
Manually creates a todo for the current user on a merge request.
914
If there already exists a todo for the user on that merge request,
915 916 917
status code `304` is returned.

```
918
POST /projects/:id/merge_requests/:merge_request_iid/todo
919 920
```

921 922
| Attribute           | Type    | Required | Description                          |
| ---------           | ----    | -------- | -----------                          |
923
| `id`                | integer/string | yes      | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user                  |
924
| `merge_request_iid` | integer | yes      | The internal ID of the merge request |
925 926

```bash
927
curl --request POST --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" https://gitlab.example.com/api/v4/projects/5/merge_requests/27/todo
928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947
```

Example response:

```json
{
  "id": 113,
  "project": {
    "id": 3,
    "name": "Gitlab Ci",
    "name_with_namespace": "Gitlab Org / Gitlab Ci",
    "path": "gitlab-ci",
    "path_with_namespace": "gitlab-org/gitlab-ci"
  },
  "author": {
    "name": "Administrator",
    "username": "root",
    "id": 1,
    "state": "active",
    "avatar_url": "http://www.gravatar.com/avatar/e64c7d89f26bd1972efa854d13d7dd61?s=80&d=identicon",
948
    "web_url": "https://gitlab.example.com/root"
949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970
  },
  "action_name": "marked",
  "target_type": "MergeRequest",
  "target": {
    "id": 27,
    "iid": 7,
    "project_id": 3,
    "title": "Et voluptas laudantium minus nihil recusandae ut accusamus earum aut non.",
    "description": "Veniam sunt nihil modi earum cumque illum delectus. Nihil ad quis distinctio quia. Autem eligendi at quibusdam repellendus.",
    "state": "opened",
    "created_at": "2016-06-17T07:48:04.330Z",
    "updated_at": "2016-07-01T11:14:15.537Z",
    "target_branch": "allow_regex_for_project_skip_ref",
    "source_branch": "backup",
    "upvotes": 0,
    "downvotes": 0,
    "author": {
      "name": "Jarret O'Keefe",
      "username": "francisca",
      "id": 14,
      "state": "active",
      "avatar_url": "http://www.gravatar.com/avatar/a7fa515d53450023c83d62986d0658a8?s=80&d=identicon",
971
      "web_url": "https://gitlab.example.com/francisca"
972 973 974 975 976 977 978
    },
    "assignee": {
      "name": "Dr. Gabrielle Strosin",
      "username": "barrett.krajcik",
      "id": 4,
      "state": "active",
      "avatar_url": "http://www.gravatar.com/avatar/733005fcd7e6df12d2d8580171ccb966?s=80&d=identicon",
979
      "web_url": "https://gitlab.example.com/barrett.krajcik"
980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995
    },
    "source_project_id": 3,
    "target_project_id": 3,
    "labels": [],
    "work_in_progress": false,
    "milestone": {
      "id": 27,
      "iid": 2,
      "project_id": 3,
      "title": "v1.0",
      "description": "Quis ea accusantium animi hic fuga assumenda.",
      "state": "active",
      "created_at": "2016-06-17T07:47:33.840Z",
      "updated_at": "2016-06-17T07:47:33.840Z",
      "due_date": null
    },
996
    "merge_when_pipeline_succeeds": false,
997 998
    "merge_status": "unchecked",
    "subscribed": true,
999 1000
    "sha": "8888888888888888888888888888888888888888",
    "merge_commit_sha": null,
1001 1002
    "user_notes_count": 7,
    "should_remove_source_branch": true,
1003 1004
    "force_remove_source_branch": false,
    "web_url": "http://example.com/example/example/merge_requests/1"
1005 1006 1007 1008 1009 1010 1011
  },
  "target_url": "https://gitlab.example.com/gitlab-org/gitlab-ci/merge_requests/7",
  "body": "Et voluptas laudantium minus nihil recusandae ut accusamus earum aut non.",
  "state": "pending",
  "created_at": "2016-07-01T11:14:15.530Z"
}
```
1012 1013 1014 1015 1016 1017

## Get MR diff versions

Get a list of merge request diff versions.

```
1018
GET /projects/:id/merge_requests/:merge_request_iid/versions
1019 1020
```

1021 1022 1023 1024
| Attribute           | Type    | Required | Description                 |
| ---------           | ------- | -------- | ---------------------       |
| `id`                | String  | yes      | The ID of the project       |
| `merge_request_iid` | integer | yes      | The internal ID of the merge request |
1025

1026
```bash
1027
curl --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" https://gitlab.example.com/api/v4/projects/1/merge_requests/1/versions
1028
```
1029

1030
Example response:
1031 1032 1033

```json
[{
1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058
  "id": 110,
  "head_commit_sha": "33e2ee8579fda5bc36accc9c6fbd0b4fefda9e30",
  "base_commit_sha": "eeb57dffe83deb686a60a71c16c32f71046868fd",
  "start_commit_sha": "eeb57dffe83deb686a60a71c16c32f71046868fd",
  "created_at": "2016-07-26T14:44:48.926Z",
  "merge_request_id": 105,
  "state": "collected",
  "real_size": "1"
}, {
  "id": 108,
  "head_commit_sha": "3eed087b29835c48015768f839d76e5ea8f07a24",
  "base_commit_sha": "eeb57dffe83deb686a60a71c16c32f71046868fd",
  "start_commit_sha": "eeb57dffe83deb686a60a71c16c32f71046868fd",
  "created_at": "2016-07-25T14:21:33.028Z",
  "merge_request_id": 105,
  "state": "collected",
  "real_size": "1"
}]
```

## Get a single MR diff version

Get a single merge request diff version.

```
1059
GET /projects/:id/merge_requests/:merge_request_iid/versions/:version_id
1060 1061
```

1062 1063 1064 1065 1066
| Attribute           | Type    | Required | Description                              |
| ---------           | ------- | -------- | ---------------------                    |
| `id`                | String  | yes      | The ID of the project                    |
| `merge_request_iid` | integer | yes      | The internal ID of the merge request     |
| `version_id`        | integer | yes      | The ID of the merge request diff version |
1067 1068

```bash
1069
curl --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" https://gitlab.example.com/api/v4/projects/1/merge_requests/1/versions/1
1070 1071 1072 1073 1074 1075
```

Example response:

```json
{
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 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118
  "id": 110,
  "head_commit_sha": "33e2ee8579fda5bc36accc9c6fbd0b4fefda9e30",
  "base_commit_sha": "eeb57dffe83deb686a60a71c16c32f71046868fd",
  "start_commit_sha": "eeb57dffe83deb686a60a71c16c32f71046868fd",
  "created_at": "2016-07-26T14:44:48.926Z",
  "merge_request_id": 105,
  "state": "collected",
  "real_size": "1",
  "commits": [{
    "id": "33e2ee8579fda5bc36accc9c6fbd0b4fefda9e30",
    "short_id": "33e2ee85",
    "title": "Change year to 2018",
    "author_name": "Administrator",
    "author_email": "admin@example.com",
    "created_at": "2016-07-26T17:44:29.000+03:00",
    "message": "Change year to 2018"
  }, {
    "id": "aa24655de48b36335556ac8a3cd8bb521f977cbd",
    "short_id": "aa24655d",
    "title": "Update LICENSE",
    "author_name": "Administrator",
    "author_email": "admin@example.com",
    "created_at": "2016-07-25T17:21:53.000+03:00",
    "message": "Update LICENSE"
  }, {
    "id": "3eed087b29835c48015768f839d76e5ea8f07a24",
    "short_id": "3eed087b",
    "title": "Add license",
    "author_name": "Administrator",
    "author_email": "admin@example.com",
    "created_at": "2016-07-25T17:21:20.000+03:00",
    "message": "Add license"
  }],
  "diffs": [{
    "old_path": "LICENSE",
    "new_path": "LICENSE",
    "a_mode": "0",
    "b_mode": "100644",
    "diff": "--- /dev/null\n+++ b/LICENSE\n@@ -0,0 +1,21 @@\n+The MIT License (MIT)\n+\n+Copyright (c) 2018 Administrator\n+\n+Permission is hereby granted, free of charge, to any person obtaining a copy\n+of this software and associated documentation files (the \"Software\"), to deal\n+in the Software without restriction, including without limitation the rights\n+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell\n+copies of the Software, and to permit persons to whom the Software is\n+furnished to do so, subject to the following conditions:\n+\n+The above copyright notice and this permission notice shall be included in all\n+copies or substantial portions of the Software.\n+\n+THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\n+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\n+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\n+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\n+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\n+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\n+SOFTWARE.\n",
    "new_file": true,
    "renamed_file": false,
    "deleted_file": false
  }]
1119
}
1120
```
1121 1122 1123 1124 1125
## Set a time estimate for a merge request

Sets an estimated time of work for this merge request.

```
1126
POST /projects/:id/merge_requests/:merge_request_iid/time_estimate
1127 1128
```

1129 1130
| Attribute           | Type    | Required | Description                              |
| ---------           | ----    | -------- | -----------                              |
1131
| `id`                | integer/string | yes      | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user                      |
1132 1133
| `merge_request_iid` | integer | yes      | The internal ID of the merge request     |
| `duration`          | string  | yes      | The duration in human format. e.g: 3h30m |
1134 1135

```bash
1136
curl --request POST --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" https://gitlab.example.com/api/v4/projects/5/merge_requests/93/time_estimate?duration=3h30m
1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154
```

Example response:

```json
{
  "human_time_estimate": "3h 30m",
  "human_total_time_spent": null,
  "time_estimate": 12600,
  "total_time_spent": 0
}
```

## Reset the time estimate for a merge request

Resets the estimated time for this merge request to 0 seconds.

```
1155
POST /projects/:id/merge_requests/:merge_request_iid/reset_time_estimate
1156 1157
```

1158 1159
| Attribute           | Type    | Required | Description                                  |
| ---------           | ----    | -------- | -----------                                  |
1160
| `id`                | integer/string | yes      | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user                          |
1161
| `merge_request_iid` | integer | yes      | The internal ID of a project's merge_request |
1162 1163

```bash
1164
curl --request POST --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" https://gitlab.example.com/api/v4/projects/5/merge_requests/93/reset_time_estimate
1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182
```

Example response:

```json
{
  "human_time_estimate": null,
  "human_total_time_spent": null,
  "time_estimate": 0,
  "total_time_spent": 0
}
```

## Add spent time for a merge request

Adds spent time for this merge request

```
1183
POST /projects/:id/merge_requests/:merge_request_iid/add_spent_time
1184 1185
```

1186 1187
| Attribute           | Type    | Required | Description                              |
| ---------           | ----    | -------- | -----------                              |
1188
| `id`                | integer/string | yes      | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user                      |
1189 1190
| `merge_request_iid` | integer | yes      | The internal ID of the merge request     |
| `duration`          | string  | yes      | The duration in human format. e.g: 3h30m |
1191 1192

```bash
1193
curl --request POST --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" https://gitlab.example.com/api/v4/projects/5/merge_requests/93/add_spent_time?duration=1h
1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211
```

Example response:

```json
{
  "human_time_estimate": null,
  "human_total_time_spent": "1h",
  "time_estimate": 0,
  "total_time_spent": 3600
}
```

## Reset spent time for a merge request

Resets the total spent time for this merge request to 0 seconds.

```
1212
POST /projects/:id/merge_requests/:merge_request_iid/reset_spent_time
1213 1214
```

1215 1216
| Attribute           | Type    | Required | Description                                  |
| ---------           | ----    | -------- | -----------                                  |
1217
| `id`                | integer/string | yes      | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user                          |
1218
| `merge_request_iid` | integer | yes      | The internal ID of a project's merge_request |
1219 1220

```bash
1221
curl --request POST --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" https://gitlab.example.com/api/v4/projects/5/merge_requests/93/reset_spent_time
1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237
```

Example response:

```json
{
  "human_time_estimate": null,
  "human_total_time_spent": null,
  "time_estimate": 0,
  "total_time_spent": 0
}
```

## Get time tracking stats

```
1238
GET /projects/:id/merge_requests/:merge_request_iid/time_stats
1239 1240
```

1241 1242
| Attribute           | Type    | Required | Description                          |
| ---------           | ----    | -------- | -----------                          |
1243
| `id`                | integer/string | yes      | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user                  |
1244
| `merge_request_iid` | integer | yes      | The internal ID of the merge request |
1245 1246

```bash
1247
curl --request GET --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" https://gitlab.example.com/api/v4/projects/5/merge_requests/93/time_stats
1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259
```

Example response:

```json
{
  "human_time_estimate": "2h",
  "human_total_time_spent": "1h",
  "time_estimate": 7200,
  "total_time_spent": 3600
}
```