GitLab API icon

GitLab API

Gitlab
Join our community

Actions880

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 developers or DevOps engineers who need to programmatically access package details stored in GitLab's package registry, particularly for Composer packages associated with a group. For example, it can be used to fetch metadata or version details of a Composer package by specifying the group ID and package name.

Use Case Examples

  1. Fetch details of a Composer package named 'my-composer-package' in a GitLab group with ID '12345'.
  2. Automate retrieval of package information for dependency management or auditing purposes within a CI/CD pipeline.

Properties

Name Meaning
Skip Authentication Determines whether to skip authentication for the API request. If true, the request is made without authentication.
Authentication Specifies the authentication method to use, defaulting to GitLab API authentication. Hidden if Skip Authentication is true.
baseUrl The base URL of the GitLab instance to which the API request is sent. Defaults to https://gitlab.com.
Method The HTTP method used for the API request, such as GET, POST, PUT, DELETE, HEAD, or PATCH. Defaults to GET.
Query Parameters Collection of query parameters for the API request, specifically the Composer package name to query.
Path Parameters Collection of path parameters for the API request, specifically the group ID or URL-encoded path.

Output

JSON

  • id - The ID of the Composer package retrieved from the GitLab group.
  • name - The name of the Composer package.
  • version - The version of the Composer package.
  • description - Description of the Composer package.
  • created_at - Timestamp when the package was created.
  • updated_at - Timestamp when the package was last updated.

Dependencies

  • GitLab API authentication token or credentials

Troubleshooting

  • Ensure the group ID and package name are correctly URL-encoded and valid to avoid 404 Not Found errors.
  • If authentication is required, verify that the GitLab API token or credentials are correctly configured and have sufficient permissions to access the package registry.
  • Check the base URL to ensure it points to the correct GitLab instance, especially if using a self-hosted GitLab server.

Links

Discussion