GIgitlab
commit_statuses

List all commit statuses

Lists all commit statuses for a specified project.

get/api/v4/projects/{id}/repository/commits/{sha}/statuses

Request

  • Base URL
    https://gitlab.com
  • Auth
    none declared

Path parameters

idstring required

ID or URL-encoded path of the project.

shastring required

Hash of the commit.

Query parameters

refstring

Name of the branch or tag. Default is the default branch.

stagestring

Filter statuses by build stage.

namestring

Filter statuses by job name.

pipeline_idinteger

Filter statuses by pipeline ID.

allboolean

Include all statuses instead of latest only. Default is false.

order_by'id' | 'pipeline_id'

Values for sorting statuses. Valid values are id and pipeline_id. Default is id.

sort'asc' | 'desc'

Sort statuses in ascending or descending order. Valid values are asc and desc. Default is asc.

pageinteger

Current page number

per_pageinteger

Number of items per page

Response

List all commit statuses

idinteger required
shastring required
refstring required
statusstring required
namestring required
target_urlstring required
descriptionstring required
created_atstring date-time required
started_atstring date-time required
finished_atstring date-time required
allow_failureboolean required
coveragenumber float required
pipeline_idinteger required

Example response

[
  {
    "id": 93,
    "sha": "18f3e63d05582537db6d183d9d557be09e1f90c8",
    "ref": "develop",
    "status": "success",
    "name": "default",
    "target_url": "https://gitlab.example.com/janedoe/gitlab-foss/builds/91",
    "created_at": "2016-01-19T09:05:50.355Z",
    "started_at": "2016-01-20T08:40:25.832Z",
    "finished_at": "2016-01-21T08:40:25.832Z",
    "coverage": 98.29,
    "pipeline_id": 101,
    "author": {
      "id": 1,
      "username": "admin",
      "public_email": "john@example.com",
      "name": "Administrator",
      "state": "active",
      "avatar_url": "https://gravatar.com/avatar/1",
      "avatar_path": "/user/avatar/28/The-Big-Lebowski-400-400.png",
      "custom_attributes": [
        {
          "key": "foo",
          "value": "bar"
        }
      ],
      "web_url": "https://gitlab.example.com/root"
    }
  }
]

Changes

No recorded changes to this operation across all 5 revisions of this API.