List all releases in a project

GET

/api/v4/projects/{id}/releases

Lists all releases for a specified project. Sorted by released_at.

Authorizations

http
oauth2

Parameters

Path Parameters

required

One of:

string
integer

string

The ID or URL-encoded path of the project

Query Parameters

page

integer

default: 1 nullable

Current page number

Example

per_page

integer

default: 20 nullable

Number of items per page

Example

order_by

string

default: released_at nullable

Allowed values: released_at created_at

The field to use as order. Either released_at (default) or created_at

sort

string

default: desc nullable

Allowed values: asc desc

The direction of the order. Either desc (default) for descending order or asc for ascending order

include_html_description

boolean

nullable

If true, a response includes HTML rendered markdown of the release description

updated_before

string format: date-time

nullable

Return releases updated before the specified datetime. Format: ISO 8601 YYYY-MM-DDTHH:MM:SSZ

updated_after

string format: date-time

nullable

Return releases updated after the specified datetime. Format: ISO 8601 YYYY-MM-DDTHH:MM:SSZ

Responses

200

application/json

object

name

string

tag_name

string

description

string

created_at

string format: date-time

released_at

string format: date-time

upcoming_release

boolean

description_html

string

author

object

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

commit

object

string

short_id

string

created_at

string format: date-time

parent_ids

Array<string>

title

string

message

string

author_name

string

author_email

string

authored_date

string format: date-time

committer_name

string

committer_email

string

committed_date

string format: date-time

trailers

object

extended_trailers

object

web_url

string

milestones

object

integer format: int64

iid

integer format: int64

project_id

integer format: int64

group_id

string

title

string

description

string

state

string

created_at

string

updated_at

string

due_date

string

start_date

string

expired

boolean

web_url

string

issue_stats

object

commit_path

string

tag_path

string

assets

string

evidences

object

sha

string

filepath

string

collected_at

string format: date-time

_links

string

Example

{
  "name": "Release v1.0",
  "tag_name": "v1.0",
  "description": "Finally released v1.0",
  "created_at": "2019-01-03T01:56:19.539Z",
  "released_at": "2019-01-03T01:56:19.539Z",
  "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"
  },
  "commit": {
    "id": "2695effb5807a22ff3d138d593fd856244e155e7",
    "short_id": "2695effb",
    "created_at": "2017-07-26T11:08:53.000+02:00",
    "parent_ids": [
      "2a4b78934375d7f53875269ffd4f45fd83a84ebe"
    ],
    "title": "Initial commit",
    "message": "Initial commit",
    "author_name": "John Smith",
    "author_email": "john@example.com",
    "authored_date": "2012-05-28T04:42:42-07:00",
    "committer_name": "Jack Smith",
    "committer_email": "jack@example.com",
    "committed_date": "2012-05-28T04:42:42-07:00",
    "trailers": {
      "Merged-By": "Jane Doe janedoe@gitlab.com"
    },
    "extended_trailers": {
      "Signed-off-by": [
        "John Doe <johndoe@gitlab.com>",
        "Jane Doe <janedoe@gitlab.com>"
      ]
    },
    "web_url": "https://gitlab.example.com/janedoe/gitlab-foss/-/commit/ed899a2f4b50b4370feeea94676502b42383c746"
  },
  "commit_path": "/root/app/commit/588440f66559714280628a4f9799f0c4eb880a4a",
  "tag_path": "/root/app/-/tags/v1.0",
  "evidences": {
    "sha": "760d6cdfb0879c3ffedec13af470e0f71cf52c6cde4d",
    "filepath": "https://gitlab.example.com/root/app/-/releases/v1.0/evidence.json",
    "collected_at": "2019-01-03T01:56:19.539Z"
  }
}

400

Bad Request

404

Not Found