GitLab API

GitlabTool
Join our community

Actions1000

Overview

This node operation interacts with the GitLab API to retrieve the export status or data of a specific project by its ID or URL-encoded path. It is useful for automating project export retrievals in GitLab, such as downloading project backups or checking export progress.

Use Case Examples

  1. Automatically fetch the export status of a GitLab project to monitor backup completion.
  2. Integrate with a workflow to download project export files for archival or migration purposes.

Properties

Name Meaning
Skip Authentication Determines whether to skip the authentication process for the API request.
Authentication Specifies the authentication method to use, defaulting to GitLab API key authentication.
baseUrl The base URL of the GitLab instance to which the API request is sent, defaulting to https://gitlab.com.
Method The HTTP method used for the API request, defaulting to GET.
Path Parameters The path parameters for the API request, specifically the project ID or URL-encoded path required to identify the project to export.

Output

JSON

  • id - The ID or URL-encoded path of the project used in the request path parameter.
  • exportStatus - The status of the project export, indicating if the export is complete or in progress.
  • exportData - The data or file content of the project export if available.

Dependencies

  • GitLab API key credential

Troubleshooting

  • Ensure the project ID or URL-encoded path is correctly provided in the path parameters to avoid 404 errors.
  • Verify that the GitLab API key credential is valid and has sufficient permissions to access project export data.
  • Check the baseUrl to ensure it points to the correct GitLab instance, especially if using a self-hosted GitLab server.

Links

Discussion