GitLab API icon

GitLab API

Gitlab
Join our community

Actions880

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 group relations. For example, you can download export relations in batches or specify a particular batch number to manage large data exports efficiently.

Use Case Examples

  1. Download export relations for a GitLab group by specifying the group ID and relation name.
  2. Download export relations in batches by setting the 'batched' parameter to true and specifying the batch number.

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 The HTTP method to use for the request, defaulting to GET.
Query Parameters Query parameters for the request, including relation name, whether to download in batches, and batch number.
Path Parameters Path parameters for the request, specifically the group ID.

Output

JSON

  • id - The ID of the group.
  • relation - The name of the group relation.
  • batched - Indicates if the download is batched.
  • batch_number - The batch number being downloaded.
  • data - The downloaded export relation data content.

Dependencies

  • GitLab API key credential

Troubleshooting

  • Ensure the group ID and relation name are correctly specified; otherwise, the API may return errors or no data.
  • If authentication is skipped, ensure the GitLab instance allows unauthenticated access, or the request will fail.
  • Check the base URL to ensure it points to the correct GitLab instance, especially if using a self-hosted GitLab server.
  • If downloading in batches, verify the batch number is valid and within the available range to avoid errors.

Links

Discussion