GitLab API

GitlabTool
Join our community

Actions905

Overview

This node operation retrieves the raw content of a specific file from a GitLab project's repository using the GitLab API v4. It is useful for scenarios where you need to access the exact file content, such as fetching source code files, configuration files, or any other repository files programmatically. For example, developers can use this node to automate the retrieval of code files for analysis or deployment processes.

Use Case Examples

  1. Fetch the raw content of a README.md file from a GitLab project to display it in a documentation portal.
  2. Automatically retrieve configuration files from a repository to use in a CI/CD pipeline.

Properties

Name Meaning
Skip Authentication Whether to skip authentication for the API request.
Authentication The authentication method used for the API request, typically an API key credential.
baseUrl The base URL of the GitLab instance, defaulting to https://gitlab.com.
Method The HTTP method to use for the API request, default is GET.
Parameter Schema Defines the required and optional parameters for the API request, including project ID, file path, branch/tag/commit reference, and LFS option.
Query Parameters Optional query parameters such as 'ref' for branch/tag/commit and 'lfs' to retrieve binary data for LFS pointer files.
Path Parameters Path parameters including 'id' for the project ID and 'file_path' for the URL encoded path to the file.

Output

JSON

  • fileContent - The raw content of the requested file from the GitLab repository.

Dependencies

  • GitLab API authentication token or API key credential

Troubleshooting

  • Ensure the project ID and file path are correctly URL encoded and valid.
  • Verify that the authentication credentials have sufficient permissions to access the repository and file.
  • Check that the 'ref' parameter (branch, tag, or commit) exists in the repository.
  • If retrieving LFS files, ensure the 'lfs' parameter is correctly set to true if needed.

Links

Discussion