GitLab API

GitlabTool
Join our community

Actions905

Overview

This node operation allows downloading the export of a specific project from GitLab using the GitLab API v4. It is useful for scenarios where users need to programmatically retrieve project export files for backup, migration, or analysis purposes. For example, a user can automate the download of project exports to maintain regular backups or to transfer project data between GitLab instances.

Use Case Examples

  1. Automate downloading project export files for backup.
  2. Retrieve project export data for migration to another GitLab instance.

Properties

Name Meaning
Skip Authentication Whether to skip authentication for the request.
Authentication The authentication method used, defaulting to GitLab API key authentication.
baseUrl The base URL of the GitLab instance, defaulting to https://gitlab.com.
Method The HTTP method to use for the request, defaulting to GET.
Parameter Schema Schema defining the path parameter 'id' which is the ID or URL-encoded path of the project to export.
Request Body Schema Schema for the request body, which is null for this operation.
Request Path The API endpoint path for downloading the project export, with a placeholder for the project ID.
Path Parameters Collection of path parameters including 'id' which specifies the project ID or URL-encoded path.

Output

JSON

  • data - The downloaded project export file content or metadata returned by the API.

Dependencies

  • GitLab API key credential for authentication

Troubleshooting

  • Ensure the project ID provided in the path parameters is correct and accessible with the authenticated user.
  • Verify that the GitLab API key credential is valid and has sufficient permissions to access project exports.
  • Check the baseUrl if using a self-hosted GitLab instance to ensure it is correct.
  • Common error messages include 404 Not Found if the project ID is invalid or inaccessible, and 401 Unauthorized if authentication fails.

Links

Discussion