GitLab API

GitlabTool
Join our community

Actions1000

Overview

This node operation allows downloading export relations of a specific group from the GitLab API. It is useful for scenarios where you need to programmatically retrieve export data related to a GitLab group, such as backups or data exports for analysis or migration purposes. For example, you can download a group's export relations by specifying the group ID and the relation name, optionally handling batched downloads if the export is large.

Use Case Examples

  1. Download export relations for a GitLab group by providing the group ID and relation name.
  2. Perform batched downloads of export relations by specifying batch number and enabling batching.

Properties

Name Meaning
Skip Authentication Whether to skip authentication for the request.
Authentication The authentication method to use, defaulting to GitLab API key authentication.
baseUrl The base URL of the GitLab instance to send the request to.
Method HTTP method to use for the request, defaulting to GET.
Query Parameters Query parameters for the request, including relation name, batching options, and batch number.
Path Parameters Path parameters for the request, specifically the group ID.

Output

JSON

  • id - The ID of the group whose export relations are downloaded.
  • relation - The name of the group relation downloaded.
  • batched - Indicates if the download was performed in batches.
  • batch_number - The batch number downloaded if batching is used.

Dependencies

  • GitLab API key credential

Troubleshooting

  • Ensure the group ID and relation name are correctly specified; missing or incorrect values will cause request failures.
  • If authentication is enabled, verify that the GitLab API key credential is valid and has sufficient permissions.
  • Check the base URL to ensure it points to the correct GitLab instance, especially if using a self-hosted GitLab server.

Links

Discussion