GitLab API

GitlabTool
Join our community

Actions1000

Overview

This node operation retrieves Composer package information from a specific GitLab group using the GitLab API. It is useful for developers or DevOps engineers who need to fetch details about Composer packages hosted within a GitLab group, such as package metadata or version information. For example, it can be used to automate dependency management or to integrate package data into CI/CD pipelines.

Use Case Examples

  1. Fetch details of a Composer package named 'my-composer-package' from a GitLab group identified by its ID or URL-encoded path.
  2. Automate retrieval of package metadata for auditing or reporting purposes within a GitLab-hosted project.

Properties

Name Meaning
Skip Authentication Option to bypass authentication when making the API request.
Authentication Type of authentication used 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 used for the API request, default is GET.
Query Parameters Query parameters for the API request, specifically the Composer package name to retrieve.
Path Parameters Path parameters for the API request, specifically the group ID or URL-encoded path.

Output

JSON

  • id - The ID or URL-encoded path of the GitLab group.
  • package_name - The name of the Composer package being queried.
  • package_details - The detailed information about the Composer package returned by the API.

Dependencies

  • GitLab API key credential

Troubleshooting

  • Ensure the group ID or URL-encoded path is correctly specified; otherwise, the API request will fail.
  • Verify that the package_name query parameter is correctly provided and matches an existing Composer package in the group.
  • If authentication is enabled, ensure the GitLab API key credential is valid and has sufficient permissions to access the group packages.
  • Common error messages include 404 Not Found if the group or package does not exist, and 401 Unauthorized if authentication fails.

Links

Discussion