GitLab API icon

GitLab API

Gitlab

Actions1062

Releases → getApiV4ProjectsIdReleases

AI-generated

Summary

Retrieve a list of releases for a specified GitLab project, with optional pagination, sorting, and filtering parameters.

Inputs

  • id (required) — The ID or URL-encoded path of the project whose releases you want to retrieve.
  • page — The page number of the results to fetch. Defaults to 1.
  • per_page — The number of releases to return per page. Defaults to 20.
  • order_by — Field to sort results by, either 'released_at' (default) or 'created_at'.
  • sort — Sort direction, 'desc' (default) for descending or 'asc' for ascending order.
  • include_html_description — Include HTML-rendered markdown of the release description if set to true.
  • updated_before — Filter to releases updated before this ISO 8601 datetime.
  • updated_after — Filter to releases updated after this ISO 8601 datetime.

Output shape

a list of release objects corresponding to the specified project, respecting pagination and filtering options

The API supports pagination through 'page' and 'per_page'. Responses will include releases sorted and filtered based on parameters provided. If authentication is disabled via 'Skip Authentication', requests may fail depending on GitLab instance configuration.

Examples

Example 1: Fetch all releases for project 'my-group/my-project'

Set 'id' to 'my-group/my-project', use defaults for pagination and sorting.

Links

Discussion