GitLab API

GitlabTool
Join our community

Actions905

Overview

This node operation is designed to download a specific release asset file from a GitLab project. It targets the GitLab API endpoint that retrieves a file associated with a release tag by specifying the project ID or path, the release tag name, and the direct path to the asset file. This is useful for automating the retrieval of release files such as binaries, archives, or other assets published in GitLab releases.

Use Case Examples

  1. Automatically download the latest release binary of a project for deployment.
  2. Fetch a specific release asset file for backup or analysis.
  3. Integrate release asset downloads into CI/CD pipelines to use the exact release files.

Properties

Name Meaning
Skip Authentication Whether to skip authentication for the request (boolean). Defaults to false.
Authentication The authentication method used, typically an API key credential for GitLab.
baseUrl The base URL of the GitLab instance, defaulting to https://gitlab.com.
Method HTTP method to use for the request, default is GET.
Parameter Schema Defines required path and query parameters for the API call: project ID or path, release tag name, and direct asset path to the file to download.
Request Path The API endpoint path template for the download operation.
Query Parameters Collection of query parameters, specifically the direct_asset_path which specifies the file path to download.
Path Parameters Collection of path parameters including project ID or URL-encoded path and the release tag name.

Output

JSON

  • downloadedFile - The downloaded release asset file content or metadata returned by the API.

Dependencies

  • GitLab API authentication token or API key credential

Troubleshooting

  • Ensure the project ID or path and tag name are correctly URL-encoded to avoid 404 errors.
  • Verify the direct_asset_path matches exactly the path specified when the release asset was created.
  • Authentication errors may occur if the API token is missing, expired, or lacks sufficient permissions.
  • Network or baseUrl misconfiguration can cause connection failures; verify the baseUrl is correct for your GitLab instance.

Links

Discussion