GitLab API

GitlabTool
Join our community

Actions1000

Overview

This node operation interacts with the GitLab API to retrieve information about a specific Composer package within a GitLab group. It is useful for users who want to programmatically access package details by specifying the group ID and the Composer package name. For example, it can be used in automation workflows to fetch package metadata for dependency management or auditing purposes.

Use Case Examples

  1. Retrieve details of a Composer package named 'my-composer-package' in a GitLab group with a specific ID.
  2. Automate the process of checking package versions or metadata in a CI/CD pipeline.

Properties

Name Meaning
Skip Authentication Determines whether to skip authentication for the API request.
Authentication Specifies the authentication method to use, defaulting to GitLab API authentication.
baseUrl The base URL of the GitLab instance, defaulting to https://gitlab.com.
Method The HTTP method to use for the API request, defaulting to 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.

Output

JSON

  • id - The ID or URL-encoded path of the GitLab group.
  • package_name - The Composer package name.
  • package_details - Details of the Composer package retrieved from the GitLab API.

Dependencies

  • GitLab API authentication token

Troubleshooting

  • Ensure the group ID and package name are correctly URL-encoded to avoid request errors.
  • Verify that the GitLab API token has sufficient permissions to access group packages.
  • Check the base URL if using a self-hosted GitLab instance to ensure it is correct.
  • Common error messages may include authentication failures or 404 not found if the group or package does not exist.

Links

Discussion