GitLab API

GitlabTool
Join our community

Actions905

Overview

This node operation retrieves package files from a specific package within a project on GitLab using the GitLab API v4. It is useful for scenarios where users need to list or manage files associated with a package in a GitLab project, such as automating package file retrieval for CI/CD pipelines or auditing package contents.

Use Case Examples

  1. Retrieve all files for a given package in a project to verify contents before deployment.
  2. Automate the download or processing of package files as part of a build or release workflow.

Properties

Name Meaning
Skip Authentication Option to skip authentication for the API request.
Authentication Type of authentication used for the API request, defaulting to GitLab API key authentication.
baseUrl Base URL of the GitLab instance to which the API request is sent, defaulting to https://gitlab.com.
Method HTTP method used for the API request, defaulting to GET.
Parameter Schema Defines the required and optional parameters for the API request, including project ID, package ID, and pagination options.
Query Parameters Optional query parameters for pagination, including page number and items per page.
Path Parameters Required path parameters specifying the project ID and package ID to identify the package files to retrieve.

Output

JSON

  • id - Unique identifier of the package file.
  • name - Name of the package file.
  • size - Size of the package file in bytes.
  • created_at - Timestamp when the package file was created.
  • file_type - Type of the package file.
  • file_path - Path to the package file within the package.

Dependencies

  • GitLab API key credential for authentication

Troubleshooting

  • Ensure the project ID and package ID path parameters are correctly set and URL-encoded if necessary.
  • Verify that the GitLab API key credential has sufficient permissions to access the project and package files.
  • Check the base URL to ensure it points to the correct GitLab instance, especially if using a self-hosted GitLab server.
  • If pagination parameters are used, ensure they are valid integers to avoid API errors.

Links

Discussion