GitLab API

GitlabTool
Join our community

Actions905

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, release dates, and version tags. For example, it can be used to automate monitoring of new releases in a project or to integrate release data into other workflows.

Use Case Examples

  1. Fetch all releases for a project to display in a dashboard.
  2. Retrieve release details to trigger notifications when a new release is published.

Properties

Name Meaning
Skip Authentication If true, the node will skip using authentication for the API request.
Authentication The authentication method used for the API request, defaulting to GitLab API key authentication.
baseUrl The base URL of the GitLab instance to send the API request to, default is https://gitlab.com.
Method The HTTP method to use for the API request, default is GET.
Parameter Schema Defines the parameters for the API request including project ID, pagination, sorting, and filtering options.
Query Parameters Optional query parameters to customize the API request such as page number, items per page, order, sort direction, HTML description inclusion, and date filters.
Path Parameters Path parameters for the API request, 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 description or notes of the release.
  • released_at - The date and time when the release was made available.
  • created_at - The date and time when the release was created.
  • author - Information about the author of the release.
  • assets - Assets associated with the release, such as links to binaries or source code.

Dependencies

  • GitLab API key credential

Troubleshooting

  • Ensure the project ID or URL-encoded path is correct to avoid 404 errors.
  • Verify that the API key credential has sufficient permissions to access project release information.
  • Check the base URL if using a self-hosted GitLab instance to ensure the API endpoint is reachable.
  • If pagination parameters are used, ensure they are valid integers to avoid request errors.

Links

Discussion