GitLab API

GitlabTool
Join our community

Actions905

Overview

This node operation allows exporting relations of a specific group in GitLab by making a POST request to the GitLab API endpoint `/api/v4/groups/{id}/export_relations`. It is useful for scenarios where you need to export group-related data such as project relations or subgroup relations for backup, migration, or analysis purposes.

Use Case Examples

  1. Exporting subgroup and project relations of a GitLab group to migrate to another instance.
  2. Backing up group relations data for auditing or compliance.

Properties

Name Meaning
Skip Authentication Whether to skip authentication for the API request.
Authentication The authentication method used for the API request, typically an API key credential.
baseUrl The base URL of the GitLab instance to which the API request is sent.
Method The HTTP method used for the API request, here it is POST for this operation.
Path Parameters The path parameters for the API request, specifically the group ID to export relations for.

Output

JSON

  • id - The ID of the group whose relations are exported.
  • export_status - Status of the export operation.
  • exported_relations - Details of the exported relations data returned by the API.

Dependencies

  • GitLab API authentication credential

Troubleshooting

  • Ensure the group ID provided in the path parameters is valid and accessible by the authenticated user.
  • Check that the GitLab API token has sufficient permissions to export group relations.
  • Verify the base URL is correct and points to a valid GitLab instance.
  • If skipping authentication, ensure the API endpoint allows unauthenticated access, otherwise the request will fail.

Links

Discussion