GitLab API

GitlabTool
Join our community

Actions905

Overview

This node operation retrieves the export status or data of a specific project from the GitLab API (v4). It is useful for workflows that need to programmatically check or download project export data from GitLab, such as automating backups or migrations of GitLab projects.

Use Case Examples

  1. Automate checking the export status of a GitLab project by its ID.
  2. Download the exported project data for backup purposes.

Properties

Name Meaning
Skip Authentication Whether to skip authentication for the request.
Authentication The authentication method to use for the request, 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 Defines 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 GET operation.
Request Path The API endpoint path template for the export operation, /api/v4/projects/{id}/export.
Path Parameters Collection of path parameters, specifically the 'id' of the project to export.

Output

JSON

  • id - The ID or URL-encoded path of the project requested for export.
  • export_status - The status of the project export process.
  • export_data - The exported project data returned by the API, if available.

Dependencies

  • GitLab API key credential for authentication

Troubleshooting

  • Ensure the project ID provided in the path parameters is correct and URL-encoded if necessary.
  • Verify that the GitLab API key credential is valid and has sufficient permissions to access project export data.
  • If skipping authentication, confirm that the GitLab instance allows unauthenticated access to the export endpoint (rare).
  • Common error messages include 404 Not Found if the project ID is invalid, 401 Unauthorized if authentication fails, and 403 Forbidden if permissions are insufficient.

Links

Discussion