GitLab API

GitlabTool

Actions1000

Overview

This node operation allows importing a group into GitLab using the GitLab API. It is useful for automating the process of importing group data from an export file into a GitLab instance, which can be beneficial for migrating groups or restoring group data programmatically.

Use Case Examples

  1. Import a group export file into GitLab to restore group settings and members.
  2. Automate group creation and import in GitLab as part of a CI/CD pipeline or administrative workflow.

Properties

Name Meaning
Skip Authentication Determines whether to skip authentication for the API request.
Authentication Specifies the authentication method to use, defaulting to GitLab API authentication.
baseUrl The base URL of the GitLab instance to which the request is sent.
Method The HTTP method to use for the request, defaulting to GET but can be set to POST for this operation.
path The API endpoint path for importing groups, fixed to '/api/v4/groups/import' for this operation.
parameterSchema Defines the parameters required for the group import operation, including group path, name, export file, optional parent group ID, and optional organization ID.

Output

JSON

  • id - The unique identifier of the imported group.
  • name - The name of the imported group.
  • path - The path of the imported group.
  • parent_id - The ID of the parent group if specified.
  • organization_id - The ID of the organization the group belongs to.

Dependencies

  • GitLab API authentication credential

Troubleshooting

  • Ensure the export file is correctly formatted and valid for import to avoid errors.
  • Verify that the base URL is correct and accessible.
  • Authentication errors may occur if the API key or token is invalid or missing.
  • Check that required parameters like 'path', 'name', and 'file' are provided and correctly formatted.

Links

Discussion