GitLab API icon

GitLab API

Gitlab
Join our community

Actions880

Overview

This node operation allows users to export 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 programmatically export group-related data, such as group memberships or project associations, for backup, migration, or analysis purposes.

Use Case Examples

  1. Exporting group relations for a group with a specific ID to back up group data.
  2. Automating the export of group relations as part of a migration process to another GitLab instance.

Properties

Name Meaning
Skip Authentication Option to skip authentication for the request, useful for testing or public endpoints.
Authentication Specifies the authentication method to use, defaulting to GitLab API key authentication.
baseUrl The base URL of the GitLab instance to which the request is sent, defaulting to https://gitlab.com.
Method HTTP method to use for the request, default is GET but POST is used for this operation.
Path Parameters Parameters to be included in the request path, specifically the group ID for this operation.

Output

JSON

  • id - The ID of the group for which relations are exported
  • exportStatus - Status of the export operation
  • exportedRelations - Details of the exported relations data returned by the API

Dependencies

  • GitLab API key credential for authentication

Troubleshooting

  • Ensure the group ID provided in the path parameters is valid and accessible by the authenticated user.
  • Verify that the GitLab API key credential is correctly configured and has sufficient permissions to export group relations.
  • Check the base URL to ensure it points to the correct GitLab instance, especially if using a self-hosted GitLab server.
  • Common error messages may include authentication failures, invalid group ID, or insufficient permissions. Resolving these typically involves verifying credentials, permissions, and input parameters.

Links

Discussion