GitLab API icon

GitLab API

Gitlab
Join our community

Actions880

Overview

This node operation interacts with the GitLab API to retrieve Composer package archives for a specific project. It is useful for developers or DevOps engineers who need to programmatically access Composer package archives stored in GitLab projects, for example, to automate package management or integrate package retrieval into CI/CD pipelines.

Use Case Examples

  1. Retrieve a Composer package archive by specifying the project ID, package name, and SHA checksum to verify the package version.
  2. Automate the download of Composer packages from GitLab for deployment or testing purposes.

Properties

Name Meaning
Skip Authentication Option to skip authentication when making the API request.
Authentication Type of authentication to use for the API request, defaulting to GitLab API key authentication.
baseUrl The base URL of the GitLab instance, defaulting to https://gitlab.com.
Method HTTP method to use for the API request, defaulting to GET.
Query Parameters Parameters sent in the query string of the API request, including 'sha' (the SHA checksum of the current JSON) and 'package_name' (the Composer package name).
Path Parameters Parameters sent in the URL path of the API request, including 'id' which is the ID or URL-encoded path of the GitLab project.

Output

JSON

  • id - The ID or URL-encoded path of the GitLab project used in the request.
  • sha - The SHA checksum of the Composer package JSON used to identify the package version.
  • package_name - The name of the Composer package requested.
  • response - The response data from the GitLab API containing the Composer package archive information.

Dependencies

  • GitLab API key credential

Troubleshooting

  • Ensure the project ID ('id') is correct and accessible with the provided authentication to avoid 404 or permission errors.
  • Verify that the 'sha' and 'package_name' query parameters are correctly specified to retrieve the intended package archive.
  • If skipping authentication, confirm that the GitLab instance allows unauthenticated access to the requested resource, otherwise authentication errors will occur.
  • Check the base URL if using a self-hosted GitLab instance to ensure it is correctly set.

Links

Discussion