GitLab API

GitlabTool
Join our community

Actions1000

Overview

This node operation retrieves a specific PyPi package file from a GitLab project using the GitLab API. It is useful for scenarios where you need to access or download a PyPi package file by specifying the project ID, the file's SHA256 checksum, and the file identifier. For example, it can be used to automate package management or verify package integrity in CI/CD pipelines.

Use Case Examples

  1. Download a PyPi package file from a GitLab project by providing the project ID, SHA256 checksum, and file identifier.
  2. Automate retrieval of PyPi package files for deployment or analysis.

Properties

Name Meaning
Skip Authentication Option to skip authentication when making 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, defaulting to https://gitlab.com.
Method HTTP method used for the API request, defaulting to GET.
Query Parameters Query parameters for the API request, specifically the file identifier of the PyPi package file.
Path Parameters Path parameters for the API request, including the project ID and the SHA256 checksum of the PyPi package file.

Output

JSON

  • id - The ID or URL-encoded path of the project.
  • file_identifier - The PyPi package file identifier.
  • sha256 - The SHA256 checksum of the PyPi package file.

Dependencies

  • GitLab API key credential

Troubleshooting

  • Ensure the project ID, SHA256 checksum, and file identifier are correctly provided and URL-encoded if necessary.
  • Verify that the GitLab API key credential is valid and has sufficient permissions to access the project and package files.
  • Check the base URL to ensure it points to the correct GitLab instance.
  • Common error messages may include 401 Unauthorized (invalid or missing authentication), 404 Not Found (incorrect project ID, SHA256, or file identifier), and 400 Bad Request (malformed request parameters).

Links

Discussion