Skip to content

List all commit statuses

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

Lists all commit statuses for a specified project.

id
required
One of:
string

ID or URL-encoded path of the project.

sha
required
string

Hash of the commit.

Example
18f3e63d05582537db6d183d9d557be09e1f90c8
ref
string
nullable

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

Example
develop
stage
string
nullable

Filter statuses by build stage.

Example
test
name
string
nullable

Filter statuses by job name.

Example
bundler:audit
pipeline_id
integer
nullable

Filter statuses by pipeline ID.

Example
1234
all
boolean
nullable

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

order_by
string
default: id nullable
Allowed values: id pipeline_id

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

sort
string
nullable
Allowed values: asc desc

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

page
integer
default: 1 nullable

Current page number

Example
1
per_page
integer
default: 20 nullable

Number of items per page

Example
20

OK

Media type application/json
object
id
integer format: int64
sha
string
ref
string
status
string
name
string
target_url
string
description
string
created_at
string format: date-time
started_at
string format: date-time
finished_at
string format: date-time
allow_failure
boolean
coverage
number format: float
pipeline_id
integer format: int64
author
object
id
integer format: int64
username
string
public_email
string
name
string
state
string
locked
boolean
avatar_url
string
avatar_path
string
custom_attributes
Array<object>
object
key
string
value
string
web_url
string
Example
{
"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",
"allow_failure": false,
"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"
}
}

Bad Request

Unauthorized

Forbidden

Not found