GitLab API icon

GitLab API

Gitlab

Actions917

Overview

This node operation interacts with the GitLab API to retrieve Maven package files by specifying the package path and file name. It is useful for automating the download or inspection of Maven package artifacts stored in GitLab's package registry. For example, it can be used in CI/CD pipelines to fetch specific Maven package versions or files for deployment or analysis.

Use Case Examples

  1. Retrieve a specific Maven package file from a GitLab repository by providing the package path and file name.
  2. Automate the download of Maven artifacts during a build process by specifying the package path and file name in the node.

Properties

Name Meaning
Skip Authentication Determines whether to skip authentication when making the API request.
Authentication Specifies the authentication method to use, defaulting to GitLab API key authentication.
baseUrl The base URL of the GitLab instance to which the API requests are sent.
Method The HTTP method used for the API request, defaulting to GET.
Query Parameters Query parameters for the API request, including the 'path' which specifies the Maven package path.
Path Parameters Path parameters for the API request, including 'file_name' which specifies the Maven package file name to retrieve.

Output

JSON

  • response - The JSON response from the GitLab API containing the requested Maven package file data.

Dependencies

  • GitLab API key credential

Troubleshooting

  • Ensure the 'path' query parameter and 'file_name' path parameter are correctly specified and match the Maven package and file in GitLab.
  • Verify that the GitLab API key credential is valid and has sufficient permissions to access the package registry.
  • Check the baseUrl to ensure it points to the correct GitLab instance if using a self-hosted GitLab server.
  • Common error messages include 401 Unauthorized (invalid or missing authentication), 404 Not Found (incorrect path or file name), and 403 Forbidden (insufficient permissions). Resolving these involves correcting credentials, parameters, or permissions.

Links

Discussion