Skip to content

Commits API

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

Use the commits API to manage Git commits in GitLab repositories.

Responses

Some date fields in responses from this API are, or can appear to be, duplicated information:

  • The created_at field exists solely for consistency with other GitLab APIs. It is always identical to the committed_date field.
  • The committed_date and authored_date fields are generated from different sources, and may not be identical.

Pagination response headers

For performance reasons, GitLab does not return the following headers in Commits API responses:

  • x-total
  • x-total-pages

For more information, see issue 389582.

List repository commits

Get a list of repository commits in a project.

GET /projects/:id/repository/commits
Attribute Type Required Description
id integer or string Yes The ID or URL-encoded path of the project.
all boolean No Retrieve every commit from the repository. If true, the ref_name parameter is ignored.
author string No Search commits by commit author.
first_parent boolean No If true, follows only the first parent commit upon seeing a merge commit.
order string No List commits in order. Possible values: default, topo. Defaults to default, the commits are shown in reverse chronological order.
path string No The file path.
ref_name string No The name of a repository branch, tag or revision range, or if not given the default branch.
since string No Only commits after or on this date are returned in ISO 8601 format YYYY-MM-DDTHH:MM:SSZ.
trailers boolean No If true, parses and includes Git trailers for every commit.
until string No Only commits before or on this date are returned in ISO 8601 format YYYY-MM-DDTHH:MM:SSZ.
with_stats boolean No If true, retrieve stats about each commit.

If successful, returns 200 OK and the following response attributes:

Attribute Type Description
author_email string Email address of the commit author.
author_name string Name of the commit author.
authored_date string Date when the commit was authored.
committed_date string Date when the commit was committed.
committer_email string Email address of the commit committer.
committer_name string Name of the commit committer.
created_at string Date when the commit was created (identical to committed_date).
extended_trailers object Extended Git trailers with all values.
id string SHA of the commit.
message string Full commit message.
parent_ids array Array of parent commit SHAs.
short_id string Short SHA of the commit.
title string Title of the commit message.
trailers object Git trailers parsed from the commit message.
web_url string Web URL of the commit. 
curl --header "PRIVATE-TOKEN: <your_access_token>" \
  --url "https://gitlab.example.com/api/v4/projects/5/repository/commits"

Example response:

[
  {
    "id": "ed899a2f4b50b4370feeea94676502b42383c746",
    "short_id": "ed899a2f4b5",
    "title": "Replace sanitize with escape once",
    "author_name": "Example User",
    "author_email": "user@example.com",
    "authored_date": "2021-09-20T11:50:22.001+00:00",
    "committer_name": "Administrator",
    "committer_email": "admin@example.com",
    "committed_date": "2021-09-20T11:50:22.001+00:00",
    "created_at": "2021-09-20T11:50:22.001+00:00",
    "message": "Replace sanitize with escape once",
    "parent_ids": [
      "6104942438c14ec7bd21c6cd5bd995272b3faff6"
    ],
    "web_url": "https://gitlab.example.com/janedoe/gitlab-foss/-/commit/ed899a2f4b50b4370feeea94676502b42383c746",
    "trailers": {},
    "extended_trailers": {}
  },
  {
    "id": "6104942438c14ec7bd21c6cd5bd995272b3faff6",
    "short_id": "6104942438c",
    "title": "Sanitize for network graph",
    "author_name": "randx",
    "author_email": "user@example.com",
    "committer_name": "ExampleName",
    "committer_email": "user@example.com",
    "created_at": "2021-09-20T09:06:12.201+00:00",
    "message": "Sanitize for network graph\nCc: John Doe <johndoe@gitlab.com>\nCc: Jane Doe <janedoe@gitlab.com>",
    "parent_ids": [
      "ae1d9fb46aa2b07ee9836d49862ec4e2c46fbbba"
    ],
    "web_url": "https://gitlab.example.com/janedoe/gitlab-foss/-/commit/ed899a2f4b50b4370feeea94676502b42383c746",
    "trailers": {
      "Cc": "Jane Doe <janedoe@gitlab.com>"
    },
    "extended_trailers": {
      "Cc": [
        "John Doe <johndoe@gitlab.com>",
        "Jane Doe <janedoe@gitlab.com>"
      ]
    }
  }
]

Create a commit with multiple files and actions

Create a commit by posting a JSON payload

POST /projects/:id/repository/commits
Attribute Type Required Description
actions[] array Yes An array of action hashes to commit as a batch. See the next table for what attributes it can take.
branch string Yes Name of the branch to commit into. To create a new branch, also provide either start_branch or start_sha, and optionally start_project.
commit_message string Yes Commit message.
id integer or string Yes The ID or URL-encoded path of the project.
author_email string No Specify the commit author's email address.
author_name string No Specify the commit author's name.
force boolean No If true, overwrites the target branch with a new commit based on the start_branch or start_sha.
start_branch string No Name of the branch to start the new branch from.
start_project integer or string No The project ID or URL-encoded path of the project to start the new branch from. Defaults to the value of id.
start_sha string No SHA of the commit to start the new branch from.
stats boolean No Include commit stats. Default is true.
actions[] Attribute Type Required Description
action string Yes The action to perform: create, delete, move, update, or chmod.
file_path string Yes Full path to the file. For example: lib/class.rb.
content string No File content, required for all except delete, chmod, and move. Move actions that do not specify content preserve the existing file content, and any other value of content overwrites the file content.
encoding string No text or base64. text is default.
execute_filemode boolean No If true, enables the execute flag on the file. If false, disables it. Only considered for chmod action.
last_commit_id string No Last known file commit ID. Only considered in update, move, and delete actions.
previous_path string No Original full path to the file being moved. For example lib/class1.rb. Only considered for move action.

If successful, returns 201 Created and the following response attributes:

Attribute Type Description
author_email string Email address of the commit author.
author_name string Name of the commit author.
authored_date string Date when the commit was authored.
committed_date string Date when the commit was committed.
committer_email string Email address of the commit committer.
committer_name string Name of the commit committer.
created_at string Date when the commit was created.
id string SHA of the created commit.
message string Full commit message.
parent_ids array Array of parent commit SHAs.
short_id string Short SHA of the created commit.
stats object Statistics about the commit (additions, deletions, total).
status string Status of the commit.
title string Title of the commit message.
web_url string Web URL of the commit. 
PAYLOAD=$(cat << 'JSON'
{
  "branch": "main",
  "commit_message": "some commit message",
  "actions": [
    {
      "action": "create",
      "file_path": "foo/bar",
      "content": "some content"
    },
    {
      "action": "delete",
      "file_path": "foo/bar2"
    },
    {
      "action": "move",
      "file_path": "foo/bar3",
      "previous_path": "foo/bar4",
      "content": "some content"
    },
    {
      "action": "update",
      "file_path": "foo/bar5",
      "content": "new content"
    },
    {
      "action": "chmod",
      "file_path": "foo/bar5",
      "execute_filemode": true
    }
  ]
}
JSON
)
curl --request POST \
  --header "PRIVATE-TOKEN: <your_access_token>" \
  --header "Content-Type: application/json" \
  --data "$PAYLOAD" \
  --url "https://gitlab.example.com/api/v4/projects/1/repository/commits"

Example response:

{
  "id": "ed899a2f4b50b4370feeea94676502b42383c746",
  "short_id": "ed899a2f4b5",
  "title": "some commit message",
  "author_name": "Example User",
  "author_email": "user@example.com",
  "committer_name": "Example User",
  "committer_email": "user@example.com",
  "created_at": "2016-09-20T09:26:24.000-07:00",
  "message": "some commit message",
  "parent_ids": [
    "ae1d9fb46aa2b07ee9836d49862ec4e2c46fbbba"
  ],
  "committed_date": "2016-09-20T09:26:24.000-07:00",
  "authored_date": "2016-09-20T09:26:24.000-07:00",
  "stats": {
    "additions": 2,
    "deletions": 2,
    "total": 4
  },
  "status": null,
  "web_url": "https://gitlab.example.com/janedoe/gitlab-foss/-/commit/ed899a2f4b50b4370feeea94676502b42383c746"
}

GitLab supports form encoding. The following is an example using Commit API with form encoding:

curl --request POST \
     --form "branch=main" \
     --form "commit_message=some commit message" \
     --form "start_branch=main" \
     --form "actions[][action]=create" \
     --form "actions[][file_path]=foo/bar" \
     --form "actions[][content]=</path/to/local.file" \
     --form "actions[][action]=delete" \
     --form "actions[][file_path]=foo/bar2" \
     --form "actions[][action]=move" \
     --form "actions[][file_path]=foo/bar3" \
     --form "actions[][previous_path]=foo/bar4" \
     --form "actions[][content]=</path/to/local1.file" \
     --form "actions[][action]=update" \
     --form "actions[][file_path]=foo/bar5" \
     --form "actions[][content]=</path/to/local2.file" \
     --form "actions[][action]=chmod" \
     --form "actions[][file_path]=foo/bar5" \
     --form "actions[][execute_filemode]=true" \
     --header "PRIVATE-TOKEN: <your_access_token>" \
     --url "https://gitlab.example.com/api/v4/projects/1/repository/commits"

Get a single commit

Get a specific commit identified by the commit hash or name of a branch or tag.

GET /projects/:id/repository/commits/:sha

Parameters:

Attribute Type Required Description
id integer or string Yes The ID or URL-encoded path of the project.
sha string Yes The commit hash or name of a repository branch or tag.
stats boolean No Include commit stats. Default is true.

If successful, returns 200 OK and the following response attributes:

Attribute Type Description
author_email string Email address of the commit author.
author_name string Name of the commit author.
authored_date string Date when the commit was authored.
committed_date string Date when the commit was committed.
committer_email string Email address of the commit committer.
committer_name string Name of the commit committer.
created_at string Date when the commit was created.
id string SHA of the commit.
last_pipeline object Information about the last pipeline for this commit.
message string Full commit message.
parent_ids array Array of parent commit SHAs.
short_id string Short SHA of the commit.
stats object Statistics about the commit (additions, deletions, total).
status string Status of the commit.
title string Title of the commit message.
web_url string Web URL of the commit. 
curl --header "PRIVATE-TOKEN: <your_access_token>" \
  --url "https://gitlab.example.com/api/v4/projects/5/repository/commits/main"

Example response:

{
  "id": "6104942438c14ec7bd21c6cd5bd995272b3faff6",
  "short_id": "6104942438c",
  "title": "Sanitize for network graph",
  "author_name": "randx",
  "author_email": "user@example.com",
  "committer_name": "Dmitriy",
  "committer_email": "user@example.com",
  "created_at": "2021-09-20T09:06:12.300+03:00",
  "message": "Sanitize for network graph",
  "committed_date": "2021-09-20T09:06:12.300+03:00",
  "authored_date": "2021-09-20T09:06:12.420+03:00",
  "parent_ids": [
    "ae1d9fb46aa2b07ee9836d49862ec4e2c46fbbba"
  ],
  "last_pipeline": {
    "id": 8,
    "ref": "main",
    "sha": "2dc6aa325a317eda67812f05600bdf0fcdc70ab0",
    "status": "created"
  },
  "stats": {
    "additions": 15,
    "deletions": 10,
    "total": 25
  },
  "status": "running",
  "web_url": "https://gitlab.example.com/janedoe/gitlab-foss/-/commit/6104942438c14ec7bd21c6cd5bd995272b3faff6"
}

Get references a commit is pushed to

Get all references (from branches or tags) a commit is pushed to. The pagination parameters page and per_page can be used to restrict the list of references.

GET /projects/:id/repository/commits/:sha/refs

Parameters:

Attribute Type Required Description
id integer or string Yes The ID or URL-encoded path of the project.
sha string Yes The commit hash.
type string No The scope of commits. Possible values branch, tag, all. Default is all.

If successful, returns 200 OK and the following response attributes:

Attribute Type Description
name string Name of the branch or tag.
type string Type of reference (branch or tag). 
curl --header "PRIVATE-TOKEN: <your_access_token>" \
  --url "https://gitlab.example.com/api/v4/projects/5/repository/commits/5937ac0a7beb003549fc5fd26fc247adbce4a52e/refs?type=all"

Example response:

[
  {
    "type": "branch",
    "name": "'test'"
  },
  {
    "type": "branch",
    "name": "add-balsamiq-file"
  },
  {
    "type": "branch",
    "name": "wip"
  },
  {
    "type": "tag",
    "name": "v1.1.0"
  }
]

Get commit sequence

Version history

Get the sequence number of a commit in a project by following the parent links from the given commit.

This API provides essentially the same features as the git rev-list --count command for a given commit SHA.

GET /projects/:id/repository/commits/:sha/sequence

Parameters:

Attribute Type Required Description
id integer or string Yes The ID or URL-encoded path of the project.
sha string Yes The commit hash.
first_parent boolean No If true, follows only the first parent commit upon seeing a merge commit.

If successful, returns 200 OK and the following response attributes:

Attribute Type Description
count integer Sequence number of the commit.

Example request:

curl --header "PRIVATE-TOKEN: <your_access_token>" \
  --url "https://gitlab.example.com/api/v4/projects/5/repository/commits/5937ac0a7beb003549fc5fd26fc247adbce4a52e/sequence"

Example response:

{
  "count": 632
}

Cherry-pick a commit

Cherry-picks a commit to a given branch.

POST /projects/:id/repository/commits/:sha/cherry_pick

Parameters:

Attribute Type Required Description
branch string Yes The name of the branch.
id integer or string Yes The ID or URL-encoded path of the project.
sha string Yes The commit hash.
dry_run boolean No If true, does not commit any changes. Default is false.
message string No A custom commit message to use for the new commit.

If successful, returns 201 Created and the following response attributes:

Attribute Type Description
author_email string Email address of the original commit author.
author_name string Name of the original commit author.
authored_date string Date when the original commit was authored.
committed_date string Date when the cherry-picked commit was committed.
committer_email string Email address of the cherry-pick committer.
committer_name string Name of the cherry-pick committer.
created_at string Date when the cherry-picked commit was created.
id string SHA of the cherry-picked commit.
message string Full commit message.
parent_ids array Array of parent commit SHAs.
short_id string Short SHA of the cherry-picked commit.
title string Title of the commit message.
web_url string Web URL of the cherry-picked commit. 
curl --request POST \
  --header "PRIVATE-TOKEN: <your_access_token>" \
  --form "branch=main" \
  --url "https://gitlab.example.com/api/v4/projects/5/repository/commits/main/cherry_pick"

Example response:

{
  "id": "8b090c1b79a14f2bd9e8a738f717824ff53aebad",
  "short_id": "8b090c1b",
  "author_name": "Example User",
  "author_email": "user@example.com",
  "authored_date": "2016-12-12T20:10:39.000+01:00",
  "created_at": "2016-12-12T20:10:39.000+01:00",
  "committer_name": "Administrator",
  "committer_email": "admin@example.com",
  "committed_date": "2016-12-12T20:10:39.000+01:00",
  "title": "Feature added",
  "message": "Feature added\n\nSigned-off-by: Example User <user@example.com>\n",
  "parent_ids": [
    "a738f717824ff53aebad8b090c1b79a14f2bd9e8"
  ],
  "web_url": "https://gitlab.example.com/janedoe/gitlab-foss/-/commit/8b090c1b79a14f2bd9e8a738f717824ff53aebad"
}

In the event of a failed cherry-pick, the response provides context about why:

{
  "message": "Sorry, we cannot cherry-pick this commit automatically. This commit may already have been cherry-picked, or a more recent commit may have updated some of its content.",
  "error_code": "empty"
}

In this case, the cherry-pick failed because the changeset was empty and likely indicates that the commit already exists in the target branch. The other possible error code is conflict, which indicates that there was a merge conflict.

When dry_run is enabled, the server attempts to apply the cherry-pick but not actually commit any resulting changes. If the cherry-pick applies cleanly, the API responds with 200 OK:

{
  "dry_run": "success"
}

In the event of a failure, an error displays that is identical to a failure without dry run.

Revert a commit

Reverts a commit in a given branch.

POST /projects/:id/repository/commits/:sha/revert

Parameters:

Attribute Type Required Description
branch string Yes Target branch name.
id integer or string Yes The ID or URL-encoded path of the project.
sha string Yes Commit SHA to revert.
dry_run boolean No If true, does not commit any changes. Default is false.

If successful, returns 201 Created and the following response attributes:

Attribute Type Description
author_email string Email address of the revert commit author.
author_name string Name of the revert commit author.
authored_date string Date when the revert commit was authored.
committed_date string Date when the revert commit was committed.
committer_email string Email address of the revert commit committer.
committer_name string Name of the revert commit committer.
created_at string Date when the revert commit was created.
id string SHA of the revert commit.
message string Full revert commit message.
parent_ids array Array of parent commit SHAs.
short_id string Short SHA of the revert commit.
title string Title of the revert commit message.
web_url string Web URL of the revert commit. 
curl --request POST \
  --header "PRIVATE-TOKEN: <your_access_token>" \
  --form "branch=main" \
  --url "https://gitlab.example.com/api/v4/projects/5/repository/commits/a738f717824ff53aebad8b090c1b79a14f2bd9e8/revert"

Example response:

{
  "id": "8b090c1b79a14f2bd9e8a738f717824ff53aebad",
  "short_id": "8b090c1b",
  "title": "Revert \"Feature added\"",
  "created_at": "2018-11-08T15:55:26.000Z",
  "parent_ids": [
    "a738f717824ff53aebad8b090c1b79a14f2bd9e8"
  ],
  "message": "Revert \"Feature added\"\n\nThis reverts commit a738f717824ff53aebad8b090c1b79a14f2bd9e8",
  "author_name": "Administrator",
  "author_email": "admin@example.com",
  "authored_date": "2018-11-08T15:55:26.000Z",
  "committer_name": "Administrator",
  "committer_email": "admin@example.com",
  "committed_date": "2018-11-08T15:55:26.000Z",
  "web_url": "https://gitlab.example.com/janedoe/gitlab-foss/-/commit/8b090c1b79a14f2bd9e8a738f717824ff53aebad"
}

In the event of a failed revert, the response provides context about why:

{
  "message": "Sorry, we cannot revert this commit automatically. This commit may already have been reverted, or a more recent commit may have updated some of its content.",
  "error_code": "conflict"
}

In this case, the revert failed because the attempted revert generated a merge conflict. The other possible error code is empty, which indicates that the changeset was empty, likely due to the change having already been reverted.

When dry_run is enabled, the server attempts to apply the revert but not actually commit any resulting changes. If the revert applies cleanly, the API responds with 200 OK:

{
  "dry_run": "success"
}

In the event of a failure, an error displays that is identical to a failure without dry run.

Get commit diff

Version history

  • collapsed and too_large response attributes introduced in GitLab 18.4.

Get the diff of a commit in a project.

GET /projects/:id/repository/commits/:sha/diff

Parameters:

Attribute Type Required Description
id integer or string Yes The ID or URL-encoded path of the project.
sha string Yes The commit hash or name of a repository branch or tag.
unidiff boolean No If true, presents diffs in the unified diff format. Default is false. Introduced in GitLab 16.5.

If successful, returns 200 OK and the following response attributes:

Attribute Type Description
a_mode string File mode before the change.
b_mode string File mode after the change.
deleted_file boolean If true, the file was deleted.
diff string The diff content.
new_file boolean If true, this is a new file.
new_path string New path of the file.
old_path string Old path of the file.
renamed_file boolean If true, the file was renamed. 
curl --header "PRIVATE-TOKEN: <your_access_token>" \
  --url "https://gitlab.example.com/api/v4/projects/5/repository/commits/main/diff"

If successful, returns 200 OK and the following response attributes:

Attribute Type Description
a_mode string Old file mode of the file.
b_mode string New file mode of the file.
collapsed boolean File diffs are excluded but can be fetched on request.
deleted_file boolean File has been removed.
diff string Diff representation of the changes made to the file.
new_file boolean File has been added.
new_path string New path of the file.
old_path string Old path of the file.
renamed_file boolean File has been renamed.
too_large boolean File diffs are excluded and cannot be retrieved.

Example response:

[
  {
    "diff": "@@ -71,6 +71,8 @@\n sudo -u git -H bundle exec rake migrate_keys RAILS_ENV=production\n sudo -u git -H bundle exec rake migrate_inline_notes RAILS_ENV=production\n \n+sudo -u git -H bundle exec rake gitlab:assets:compile RAILS_ENV=production\n+\n ```\n \n ### 6. Update config files",
    "collapsed": false,
    "too_large": false,
    "new_path": "doc/update/5.4-to-6.0.md",
    "old_path": "doc/update/5.4-to-6.0.md",
    "a_mode": null,
    "b_mode": "100644",
    "new_file": false,
    "renamed_file": false,
    "deleted_file": false
  }
]

Get commit comments

Get the comments of a commit in a project.

GET /projects/:id/repository/commits/:sha/comments

Parameters:

Attribute Type Required Description
id integer or string Yes The ID or URL-encoded path of the project.
sha string Yes The commit hash or name of a repository branch or tag.

If successful, returns 200 OK and the following response attributes:

Attribute Type Description
author object Information about the comment author.
note string The comment text. 
curl --header "PRIVATE-TOKEN: <your_access_token>" \
  --url "https://gitlab.example.com/api/v4/projects/5/repository/commits/main/comments"

Example response:

[
  {
    "note": "this code is really nice",
    "author": {
      "id": 11,
      "username": "admin",
      "email": "admin@local.host",
      "name": "Administrator",
      "state": "active",
      "created_at": "2014-03-06T08:17:35.000Z"
    }
  }
]

Post comment to commit

Adds a comment to a commit.

To post a comment in a particular line of a particular file, you must specify the full commit SHA, the path, the line, and line_type should be new.

The comment is added at the end of the last commit if at least one of the following cases is valid:

  • the sha is instead a branch or a tag and the line or path are invalid
  • the line number is invalid (does not exist)
  • the path is invalid (does not exist)

In any of the previous cases, the response of line, line_type and path is set to null.

For other approaches to commenting on a merge request, see Create new merge request note in the Notes API, and Create a new thread in the merge request diff in the Discussions API.

POST /projects/:id/repository/commits/:sha/comments
Attribute Type Required Description
id integer or string Yes The ID or URL-encoded path of the project.
note string Yes The text of the comment.
sha string Yes The commit SHA or name of a repository branch or tag.
line integer No The line number where the comment should be placed.
line_type string No The line type. Takes new or old as arguments.
path string No The file path relative to the repository.

If successful, returns 201 Created and the following response attributes:

Attribute Type Description
author object Information about the comment author.
created_at string Date when the comment was created.
line_type string Type of line the comment is on.
line integer Line number where the comment is placed.
note string The comment text.
path string File path relative to the repository. 
curl --request POST \
  --header "PRIVATE-TOKEN: <your_access_token>" \
  --form "note=Nice picture\!" \
  --form "path=README.md" \
  --form "line=11" \
  --form "line_type=new" \
  --url "https://gitlab.example.com/api/v4/projects/17/repository/commits/18f3e63d05582537db6d183d9d557be09e1f90c8/comments"

Example response:

{
  "author": {
    "web_url": "https://gitlab.example.com/janedoe",
    "avatar_url": "https://gitlab.example.com/uploads/user/avatar/28/jane-doe-400-400.png",
    "username": "janedoe",
    "state": "active",
    "name": "Jane Doe",
    "id": 28
  },
  "created_at": "2016-01-19T09:44:55.600Z",
  "line_type": "new",
  "path": "README.md",
  "line": 11,
  "note": "Nice picture!"
}

Get commit discussions

Get the discussions of a commit in a project.

GET /projects/:id/repository/commits/:sha/discussions

Parameters:

Attribute Type Required Description
id integer or string Yes The ID or URL-encoded path of the project.
sha string Yes The commit hash or name of a repository branch or tag.

If successful, returns 200 OK and the following response attributes:

Attribute Type Description
id string ID of the discussion.
individual_note boolean If true, the discussion is an individual note.
notes array Array of notes in the discussion. 
curl --header "PRIVATE-TOKEN: <your_access_token>" \
  --url "https://gitlab.example.com/api/v4/projects/5/repository/commits/4604744a1c64de00ff62e1e8a6766919923d2b41/discussions"

Example response:

[
  {
    "id": "4604744a1c64de00ff62e1e8a6766919923d2b41",
    "individual_note": true,
    "notes": [
      {
        "id": 334686748,
        "type": null,
        "body": "Nice piece of code!",
        "attachment": null,
        "author": {
          "id": 28,
          "name": "Jane Doe",
          "username": "janedoe",
          "web_url": "https://gitlab.example.com/janedoe",
          "state": "active",
          "avatar_url": "https://gitlab.example.com/uploads/user/avatar/28/jane-doe-400-400.png"
        },
        "created_at": "2020-04-30T18:48:11.432Z",
        "updated_at": "2020-04-30T18:48:11.432Z",
        "system": false,
        "noteable_id": null,
        "noteable_type": "Commit",
        "resolvable": false,
        "confidential": null,
        "noteable_iid": null,
        "commands_changes": {}
      }
    ]
  }
]

Commit status

The commit status API for use with GitLab.

List commit statuses

Version history

  • pipeline_id, order_by, and sort fields introduced in GitLab 17.9.

List the statuses of a commit in a project. The pagination parameters page and per_page can be used to restrict the list of references.

GET /projects/:id/repository/commits/:sha/statuses
Attribute Type Required Description
id integer or string Yes ID or URL-encoded path of the project.
sha string Yes Hash of the commit.
all boolean No If true, include all statuses instead of latest only. Default is false.
name string No Filter statuses by job name. For example, bundler:audit.
order_by string No Values for sorting statuses. Valid values are id and pipeline_id. Default is id.
pipeline_id integer No Filter statuses by pipeline ID. For example, 1234.
ref string No Name of the branch or tag. Default is the default branch.
sort string No Sort statuses in ascending or descending order. Valid values are asc and desc. Default is asc.
stage string No Filter statuses by build stage. For example, test.

If successful, returns 200 OK and the following response attributes:

Attribute Type Description
allow_failure boolean If true, the status allows failure.
author object Information about the status author.
created_at string Date when the status was created.
description string Description of the status.
finished_at string Date when the status was finished.
id integer ID of the status.
name string Name of the status.
ref string Reference (branch or tag) of the commit.
sha string SHA of the commit.
started_at string Date when the status was started.
status string Status of the commit.
target_url string Target URL associated with the status. 
curl --header "PRIVATE-TOKEN: <your_access_token>" \
  --url "https://gitlab.example.com/api/v4/projects/17/repository/commits/18f3e63d05582537db6d183d9d557be09e1f90c8/statuses"

Example response:

[
  ...
  {
    "status": "pending",
    "created_at": "2016-01-19T08:40:25.934Z",
    "started_at": null,
    "name": "bundler:audit",
    "allow_failure": true,
    "author": {
      "username": "janedoe",
      "state": "active",
      "web_url": "https://gitlab.example.com/janedoe",
      "avatar_url": "https://gitlab.example.com/uploads/user/avatar/28/jane-doe-400-400.png",
      "id": 28,
      "name": "Jane Doe"
    },
    "description": null,
    "sha": "18f3e63d05582537db6d183d9d557be09e1f90c8",
    "target_url": "https://gitlab.example.com/janedoe/gitlab-foss/builds/91",
    "finished_at": null,
    "id": 91,
    "ref": "main"
  },
  {
    "started_at": null,
    "name": "test",
    "allow_failure": false,
    "status": "pending",
    "created_at": "2016-01-19T08:40:25.832Z",
    "target_url": "https://gitlab.example.com/janedoe/gitlab-foss/builds/90",
    "id": 90,
    "finished_at": null,
    "ref": "main",
    "sha": "18f3e63d05582537db6d183d9d557be09e1f90c8",
    "author": {
      "id": 28,
      "name": "Jane Doe",
      "username": "janedoe",
      "web_url": "https://gitlab.example.com/janedoe",
      "state": "active",
      "avatar_url": "https://gitlab.example.com/uploads/user/avatar/28/jane-doe-400-400.png"
    },
    "description": null
  }
  ...
]

Set commit pipeline status

Add or update the pipeline status of a commit. If the commit is associated with a merge request, the API call must target the commit in the merge request's source branch.

If a pipeline already exists and it exceeds the maximum number of jobs in a single pipeline limit:

  • If pipeline_id is specified, a 422 error is returned: The number of jobs has exceeded the limit.
  • Otherwise, a new pipeline is created.
POST /projects/:id/statuses/:sha
Attribute Type Required Description
id integer or string Yes The ID or URL-encoded path of the project.
sha string Yes The commit SHA.
state string Yes The state of the status. Can be one of the following: pending, running, success, failed, canceled, skipped.
coverage float No The total code coverage.
description string No The short description of the status. Must be 255 characters or fewer.
name or context string No The label to differentiate this status from the status of other systems. Default value is default.
pipeline_id integer No The ID of the pipeline to set status. Use in case of several pipeline on same SHA.
ref string No The ref (branch or tag) to which the status refers. Must be 255 characters or fewer.
target_url string No The target URL to associate with this status. Must be 255 characters or fewer.

If successful, returns 201 Created and the following response attributes:

Attribute Type Description
allow_failure boolean If true, the status allows failure.
author object Information about the status author.
coverage float Code coverage percentage.
created_at string Date when the status was created.
description string Description of the status.
finished_at string Date when the status was finished.
id integer ID of the status.
name string Name of the status.
ref string Reference (branch or tag) of the commit.
sha string SHA of the commit.
started_at string Date when the status was started.
status string Status of the commit.
target_url string Target URL associated with the status. 
curl --request POST \
  --header "PRIVATE-TOKEN: <your_access_token>" \
  --url "https://gitlab.example.com/api/v4/projects/17/statuses/18f3e63d05582537db6d183d9d557be09e1f90c8?state=success"

Example response:

{
  "author": {
    "web_url": "https://gitlab.example.com/janedoe",
    "name": "Jane Doe",
    "avatar_url": "https://gitlab.example.com/uploads/user/avatar/28/jane-doe-400-400.png",
    "username": "janedoe",
    "state": "active",
    "id": 28
  },
  "name": "default",
  "sha": "18f3e63d05582537db6d183d9d557be09e1f90c8",
  "status": "success",
  "coverage": 100.0,
  "description": null,
  "id": 93,
  "target_url": null,
  "ref": null,
  "started_at": null,
  "created_at": "2016-01-19T09:05:50.355Z",
  "allow_failure": false,
  "finished_at": "2016-01-19T09:05:50.365Z"
}

List merge requests associated with a commit

Version history

Returns information about the merge request that originally introduced a specific commit.

GET /projects/:id/repository/commits/:sha/merge_requests
Attribute Type Required Description
id integer or string Yes The ID or URL-encoded path of the project.
sha string Yes The commit SHA.
state string No Returns merge requests with the specified state: opened, closed, locked, or merged. Omit this parameter to get all merge requests regardless of state.

If successful, returns 200 OK and the following response attributes:

Attribute Type Description
assignee object Information about the merge request assignee.
author object Information about the merge request author.
created_at string Date when the merge request was created.
description string Description of the merge request.
discussion_locked boolean If true, discussions are locked.
downvotes integer Number of downvotes.
draft boolean If true, the merge request is a draft.
force_remove_source_branch boolean If true, forces source branch removal.
id integer ID of the merge request.
iid integer Internal ID of the merge request.
labels array Labels associated with the merge request.
merge_commit_sha string SHA of the merge commit.
merge_status string Merge status of the merge request.
merge_when_pipeline_succeeds boolean If true, merges when pipeline succeeds.
milestone object Milestone associated with the merge request.
project_id integer ID of the project.
sha string SHA of the merge request.
should_remove_source_branch boolean If true, removes source branch after merge.
source_branch string Source branch of the merge request.
source_project_id integer ID of the source project.
squash_commit_sha string SHA of the squash commit.
state string State of the merge request.
target_branch string Target branch of the merge request.
target_project_id integer ID of the target project.
time_stats object Time tracking statistics.
title string Title of the merge request.
updated_at string Date when the merge request was last updated.
upvotes integer Number of upvotes.
user_notes_count integer Number of user notes.
web_url string Web URL of the merge request.
work_in_progress boolean If true, the merge request is set as work in progress. 
curl --header "PRIVATE-TOKEN: <your_access_token>" \
  --url "https://gitlab.example.com/api/v4/projects/5/repository/commits/af5b13261899fb2c0db30abdd0af8b07cb44fdc5/merge_requests?state=opened"

Example response:

[
  {
    "id": 45,
    "iid": 1,
    "project_id": 35,
    "title": "Add new file",
    "description": "",
    "state": "opened",
    "created_at": "2018-03-26T17:26:30.916Z",
    "updated_at": "2018-03-26T17:26:30.916Z",
    "target_branch": "main",
    "source_branch": "test-branch",
    "upvotes": 0,
    "downvotes": 0,
    "author": {
      "web_url": "https://gitlab.example.com/janedoe",
      "name": "Jane Doe",
      "avatar_url": "https://gitlab.example.com/uploads/user/avatar/28/jane-doe-400-400.png",
      "username": "janedoe",
      "state": "active",
      "id": 28
    },
    "assignee": null,
    "source_project_id": 35,
    "target_project_id": 35,
    "labels": [],
    "draft": false,
    "work_in_progress": false,
    "milestone": null,
    "merge_when_pipeline_succeeds": false,
    "merge_status": "can_be_merged",
    "sha": "af5b13261899fb2c0db30abdd0af8b07cb44fdc5",
    "merge_commit_sha": null,
    "squash_commit_sha": null,
    "user_notes_count": 0,
    "discussion_locked": null,
    "should_remove_source_branch": null,
    "force_remove_source_branch": false,
    "web_url": "https://gitlab.example.com/root/test-project/merge_requests/1",
    "time_stats": {
      "time_estimate": 0,
      "total_time_spent": 0,
      "human_time_estimate": null,
      "human_total_time_spent": null
    }
  }
]

Get commit signature

Get the signature from a commit, if it is signed. For unsigned commits, it results in a 404 response.

GET /projects/:id/repository/commits/:sha/signature

Parameters:

Attribute Type Required Description
id integer or string Yes The ID or URL-encoded path of the project.
sha string Yes The commit hash or name of a repository branch or tag.

If successful, returns 200 OK and the following response attributes:

Attribute Type Description
commit_source string Source of the commit.
gpg_key_id integer ID of the GPG key (for PGP signatures).
gpg_key_primary_keyid string Primary key ID of the GPG key.
gpg_key_subkey_id string Subkey ID of the GPG key.
gpg_key_user_email string Email address associated with the GPG key.
gpg_key_user_name string User name associated with the GPG key.
key object SSH key information (for SSH signatures).
signature_type string Type of signature (PGP, SSH, or X509).
verification_status string Verification status of the signature.
x509_certificate object X.509 certificate information (for X.509 signatures). 
curl --header "PRIVATE-TOKEN: <your_access_token>" \
  --url "https://gitlab.example.com/api/v4/projects/1/repository/commits/da738facbc19eb2fc2cef57c49be0e6038570352/signature"

Example response if commit is GPG signed:

{
  "signature_type": "PGP",
  "verification_status": "verified",
  "gpg_key_id": 1,
  "gpg_key_primary_keyid": "8254AAB3FBD54AC9",
  "gpg_key_user_name": "John Doe",
  "gpg_key_user_email": "johndoe@example.com",
  "gpg_key_subkey_id": null,
  "commit_source": "gitaly"
}

Example response if commit is signed with SSH:

{
  "signature_type": "SSH",
  "verification_status": "verified",
  "key": {
    "id": 11,
    "title": "Key",
    "created_at": "2023-05-08T09:12:38.503Z",
    "expires_at": "2024-05-07T00:00:00.000Z",
    "key": "ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAILZzYDq6DhLp3aX84DGIV3F6Vf+Ae4yCTTz7RnqMJOlR MyKey)",
    "usage_type": "auth_and_signing"
  },
  "commit_source": "gitaly"
}

Example response if commit is X.509 signed:

{
  "signature_type": "X509",
  "verification_status": "unverified",
  "x509_certificate": {
    "id": 1,
    "subject": "CN=gitlab@example.org,OU=Example,O=World",
    "subject_key_identifier": "BC:BC:BC:BC:BC:BC:BC:BC:BC:BC:BC:BC:BC:BC:BC:BC:BC:BC:BC:BC",
    "email": "gitlab@example.org",
    "serial_number": 278969561018901340486471282831158785578,
    "certificate_status": "good",
    "x509_issuer": {
      "id": 1,
      "subject": "CN=PKI,OU=Example,O=World",
      "subject_key_identifier": "AB:AB:AB:AB:AB:AB:AB:AB:AB:AB:AB:AB:AB:AB:AB:AB:AB:AB:AB:AB",
      "crl_url": "http://example.com/pki.crl"
    }
  },
  "commit_source": "gitaly"
}

Example response if commit is unsigned:

{
  "message": "404 GPG Signature Not Found"
}