GitLab API

GitlabTool
Join our community

Actions1000

Overview

This node operation retrieves release information for a specific project from the GitLab API (version 4). It is useful for scenarios where you need to fetch details about project releases, such as release notes, version tags, and release dates. For example, it can be used to automate monitoring of new releases in a GitLab project or to integrate release data into other systems.

Use Case Examples

  1. Fetch all releases for a project by specifying the project ID.
  2. Retrieve releases with pagination by setting page and per_page query parameters.
  3. Sort releases by creation date or release date using order_by and sort parameters.

Properties

Name Meaning
Skip Authentication Whether to skip authentication when making the API request.
Authentication The authentication method to use for the API request, hidden if Skip Authentication is true.
baseUrl The base URL of the GitLab instance to connect to, defaulting to https://gitlab.com.
Method The HTTP method to use for the request, defaulting to GET.
Parameter Schema Defines the parameters accepted by the API endpoint, including path and query parameters such as project ID, pagination, sorting, and filtering options.
Query Parameters Collection of optional query parameters to customize the API request, including page, per_page, order_by, sort, include_html_description, updated_before, and updated_after.
Path Parameters Collection of path parameters required by the API endpoint, specifically the project ID (or URL-encoded path).

Output

JSON

  • id - The unique identifier of the release.
  • tag_name - The tag name associated with the release.
  • description - The release description, optionally including HTML rendered markdown.
  • created_at - The creation date and time of the release.
  • released_at - The release date and time.
  • author - Information about the author of the release.
  • assets - Assets associated with the release, such as links and sources.

Dependencies

  • GitLab API authentication token or credentials

Troubleshooting

  • Ensure the project ID is correctly specified and URL-encoded if necessary.
  • Verify that the authentication token has sufficient permissions to access project releases.
  • Check the base URL if using a self-hosted GitLab instance to ensure it is correct.
  • Handle pagination properly by using the page and per_page parameters to avoid missing data.

Links

Discussion