GitLab API

GitlabTool
Join our community

Actions905

Overview

This node operation allows downloading export relations of a specific GitLab group via the GitLab API v4. It is useful for automating the retrieval of group export data, such as project relations or other associated resources, potentially in batched segments for large datasets. For example, a user can download all export relations of a group or selectively download batches to manage large exports efficiently.

Use Case Examples

  1. Download all export relations of 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 API request.
Authentication The authentication method used for the API request, defaulting to GitLab API key authentication.
baseUrl The base URL of the GitLab instance to which the API request is sent.
Method The HTTP method used for the API request, default is GET.
Query Parameters Parameters sent as query strings in the API request to specify export relation details.
Path Parameters Parameters included in the API request path to specify the target group.

Output

JSON

  • data - The downloaded export relations data for the specified GitLab group.

Dependencies

  • GitLab API key credential for authentication

Troubleshooting

  • Ensure the group ID provided in the path parameters is correct and the group exists in the GitLab instance.
  • Verify that the 'relation' query parameter matches a valid export relation name for the group.
  • If batching is enabled, ensure the batch number is within the valid range of available batches.
  • Authentication errors may occur if the API key is missing, invalid, or lacks sufficient permissions.

Links

Discussion