Merge Trains API

  • Tier: Premium, Ultimate
  • Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated

Use this API to interact with merge trains.

Prerequisites:

  • You must have at least the Developer role.

List Merge Trains for a project

Get all Merge Trains of the requested project:

GET /projects/:id/merge_trains
GET /projects/:id/merge_trains?scope=complete

Use the page and per_page pagination parameters to control the pagination of results.

Attribute Type Required Description
id integer or string Yes The ID or URL-encoded path of the project.
scope string No Return Merge Trains filtered by the given scope. Available scopes are active (to be merged) and complete (have been merged).
sort string No Return Merge Trains sorted in asc or desc order. Default: desc. 
curl --request GET \
  --header "PRIVATE-TOKEN: <your_access_token>" \
  --url "https://gitlab.example.com/api/v4/projects/1/merge_trains"

Returns:

  • 403: Forbidden if Merge Trains are not available for the project
  • 404: Not Found if the user is not a member of a private project

Example response:

[
  {
    "id": 110,
    "merge_request": {
      "id": 126,
      "iid": 59,
      "project_id": 20,
      "title": "Test MR 1580978354",
      "description": "",
      "state": "merged",
      "created_at": "2020-02-06T08:39:14.883Z",
      "updated_at": "2020-02-06T08:40:57.038Z",
      "web_url": "http://local.gitlab.test:8181/root/merge-train-race-condition/-/merge_requests/59"
    },
    "user": {
      "id": 1,
      "name": "Administrator",
      "username": "root",
      "state": "active",
      "avatar_url": "https://www.gravatar.com/avatar/e64c7d89f26bd1972efa854d13d7dd61?s=80&d=identicon",
      "web_url": "http://local.gitlab.test:8181/root"
    },
    "pipeline": {
      "id": 246,
      "sha": "bcc17a8ffd51be1afe45605e714085df28b80b13",
      "ref": "refs/merge-requests/59/train",
      "status": "success",
      "created_at": "2020-02-06T08:40:42.410Z",
      "updated_at": "2020-02-06T08:40:46.912Z",
      "web_url": "http://local.gitlab.test:8181/root/merge-train-race-condition/pipelines/246"
    },
    "created_at": "2020-02-06T08:39:47.217Z",
    "updated_at": "2020-02-06T08:40:57.720Z",
    "target_branch": "feature-1580973432",
    "status": "merged",
    "merged_at": "2020-02-06T08:40:57.719Z",
    "duration": 70
  }
]

List merge requests in a merge train

Get all merge requests added to a merge train for the requested target branch.

GET /projects/:id/merge_trains/:target_branch

Use the page and per_page pagination parameters to control the pagination of results.

Supported attributes:

Attribute Type Required Description
id integer or string Yes The ID or URL-encoded path of the project.
target_branch string Yes The target branch of the merge train.
scope string No Return Merge Trains filtered by the given scope. Available scopes are active (to be merged) and complete (have been merged).
sort string No Return Merge Trains sorted in asc or desc order. Default: desc.

Example request:

curl --request GET \
  --header "PRIVATE-TOKEN: <your_access_token>" \
  --url "https://gitlab.example.com/api/v4/projects/597/merge_trains/main"

Returns:

  • 403: Forbidden if Merge Trains are not available for the project
  • 404: Not Found if the user is not a member of a private project

Example response:

[
  {
    "id": 267,
    "merge_request": {
      "id": 273,
      "iid": 1,
      "project_id": 597,
      "title": "My title 9",
      "description": null,
      "state": "opened",
      "created_at": "2022-10-31T19:06:05.725Z",
      "updated_at": "2022-10-31T19:06:05.725Z",
      "web_url": "http://localhost/namespace18/project21/-/merge_requests/1"
    },
    "user": {
      "id": 933,
      "username": "user12",
      "name": "Sidney Jones31",
      "state": "active",
      "avatar_url": "https://www.gravatar.com/avatar/6c8365de387cb3db10ecc7b1880203c4?s=80\u0026d=identicon",
      "web_url": "http://localhost/user12"
    },
    "pipeline": {
      "id": 273,
      "iid": 1,
      "project_id": 598,
      "sha": "b83d6e391c22777fca1ed3012fce84f633d7fed0",
      "ref": "main",
      "status": "pending",
      "source": "push",
      "created_at": "2022-10-31T19:06:06.231Z",
      "updated_at": "2022-10-31T19:06:06.231Z",
      "web_url": "http://localhost/namespace19/project22/-/pipelines/273"
    },
    "created_at": "2022-10-31T19:06:06.237Z",
    "updated_at":"2022-10-31T19:06:06.237Z",
    "target_branch":"main",
    "status":"idle",
    "merged_at":null,
    "duration":null
  }
]

Get the status of a merge request on a merge train

Get merge train information for the requested merge request.

GET /projects/:id/merge_trains/merge_requests/:merge_request_iid

Use the page and per_page pagination parameters to control the pagination of results.

Supported attributes:

Attribute Type Required Description
id integer or string Yes The ID or URL-encoded path of the project.
merge_request_iid integer Yes The internal ID of the merge request.

Example request:

curl --request GET \
  --header "PRIVATE-TOKEN: <your_access_token>" \
  --url "https://gitlab.example.com/api/v4/projects/597/merge_trains/merge_requests/1"

Returns:

  • 403: Forbidden if Merge Trains are not available for the project
  • 404: Not Found if the user is not a member of a private project

Example response:

{
  "id": 267,
  "merge_request": {
    "id": 273,
    "iid": 1,
    "project_id": 597,
    "title": "My title 9",
    "description": null,
    "state": "opened",
    "created_at": "2022-10-31T19:06:05.725Z",
    "updated_at": "2022-10-31T19:06:05.725Z",
    "web_url": "http://localhost/namespace18/project21/-/merge_requests/1"
  },
  "user": {
    "id": 933,
    "username": "user12",
    "name": "Sidney Jones31",
    "state": "active",
    "avatar_url": "https://www.gravatar.com/avatar/6c8365de387cb3db10ecc7b1880203c4?s=80\u0026d=identicon",
    "web_url": "http://localhost/user12"
  },
  "pipeline": {
    "id": 273,
    "iid": 1,
    "project_id": 598,
    "sha": "b83d6e391c22777fca1ed3012fce84f633d7fed0",
    "ref": "main",
    "status": "pending",
    "source": "push",
    "created_at": "2022-10-31T19:06:06.231Z",
    "updated_at": "2022-10-31T19:06:06.231Z",
    "web_url": "http://localhost/namespace19/project22/-/pipelines/273"
  },
  "created_at": "2022-10-31T19:06:06.237Z",
  "updated_at":"2022-10-31T19:06:06.237Z",
  "target_branch":"main",
  "status":"idle",
  "merged_at":null,
  "duration":null
}

Add a merge request to a merge train

Add a merge request to the merge train targeting the merge request's target branch.

POST /projects/:id/merge_trains/merge_requests/:merge_request_iid

Supported attributes:

Attribute Type Required Description
id integer or string Yes The ID or URL-encoded path of the project.
merge_request_iid integer Yes The internal ID of the merge request.
auto_merge boolean No If true, the merge request is added to the merge train when the checks pass. When false or unspecified, the merge request is added directly to the merge train.
sha string No If present, the SHA must match the HEAD of the source branch, otherwise the merge fails.
squash boolean No If true, the commits are squashed into a single commit on merge.
when_pipeline_succeeds boolean No Deprecated in GitLab 17.11. Use auto_merge instead.

Example request:

curl --request POST \
  --header "PRIVATE-TOKEN: <your_access_token>" \
  --url "https://gitlab.example.com/api/v4/projects/597/merge_trains/merge_requests/1"

If successful, returns:

  • 201 Created if the merge request is immediately added to the merge train
  • 202 Accepted if the merge request is scheduled to be added to the merge train

Other possible responses:

  • 400 Bad Request if the merge failed
  • 401 Unauthorized if authentication is required
  • 403 Forbidden if merge trains are not available for the project
  • 404 Not Found if the project or merge request is not found
  • 409 Conflict if there's a conflicting resource

On success, the response contains the following attributes:

Attribute Type Description
created_at datetime Timestamp of when the merge train was created.
duration integer Duration in seconds, or null if not completed.
id integer ID of the merge train.
merge_request object Merge request details.
merge_request.created_at datetime Timestamp of when the merge request was created.
merge_request.description string Description of the merge request.
merge_request.id integer ID of the merge request.
merge_request.iid integer Internal ID of the merge request.
merge_request.project_id integer ID of the project containing the merge request.
merge_request.state string State of the merge request.
merge_request.title string Title of the merge request.
merge_request.updated_at datetime Timestamp of when the merge request was last updated.
merge_request.web_url string Web URL of the merge request.
merged_at datetime Timestamp of when the merge request merged, or null if not merged.
pipeline object Pipeline details.
pipeline.created_at datetime Timestamp of when the pipeline was created.
pipeline.id integer ID of the pipeline.
pipeline.iid integer Internal ID of the pipeline.
pipeline.project_id integer ID of the project containing the pipeline.
pipeline.ref string Git reference of the pipeline.
pipeline.sha string SHA of the commit that triggered the pipeline.
pipeline.source string Source of the pipeline trigger.
pipeline.status string Status of the pipeline.
pipeline.updated_at datetime Timestamp of when the pipeline was last updated.
pipeline.web_url string Web URL of the pipeline.
status string Status of the merge train. Possible values: idle, merged, stale, fresh, merging, skip_merged.
target_branch string Name of the target branch.
updated_at datetime Timestamp of when the merge train was last updated.
user object User who added the merge request to the merge train.
user.avatar_url string Avatar URL of the user.
user.id integer ID of the user.
user.name string Name of the user.
user.state string State of the user account.
user.username string Username of the user.
user.web_url string Web URL of the user profile.

Example response:

[
  {
    "id": 267,
    "merge_request": {
      "id": 273,
      "iid": 1,
      "project_id": 597,
      "title": "My title 9",
      "description": null,
      "state": "opened",
      "created_at": "2022-10-31T19:06:05.725Z",
      "updated_at": "2022-10-31T19:06:05.725Z",
      "web_url": "http://localhost/namespace18/project21/-/merge_requests/1"
    },
    "user": {
      "id": 933,
      "username": "user12",
      "name": "Sidney Jones31",
      "state": "active",
      "avatar_url": "https://www.gravatar.com/avatar/6c8365de387cb3db10ecc7b1880203c4?s=80\u0026d=identicon",
      "web_url": "http://localhost/user12"
    },
    "pipeline": {
      "id": 273,
      "iid": 1,
      "project_id": 598,
      "sha": "b83d6e391c22777fca1ed3012fce84f633d7fed0",
      "ref": "main",
      "status": "pending",
      "source": "push",
      "created_at": "2022-10-31T19:06:06.231Z",
      "updated_at": "2022-10-31T19:06:06.231Z",
      "web_url": "http://localhost/namespace19/project22/-/pipelines/273"
    },
    "created_at": "2022-10-31T19:06:06.237Z",
    "updated_at":"2022-10-31T19:06:06.237Z",
    "target_branch":"main",
    "status":"idle",
    "merged_at":null,
    "duration":null
  }
]