GitLab API

GitlabTool

Actions1095

Bulk_imports → postApiV4BulkImports

AI-generated

Summary

Starts a GitLab bulk import by submitting source instance and entity details to /api/v4/bulk_imports. Choose the HTTP method and provide required source credentials and destination information; the source lists GET as the default method.

Inputs

  • Skip Authentication — Defaults to false. When enabled, hides the GitLab API authentication setting; the base URL defaults to https://gitlab.com.
  • Method — HTTP method for the request: GET (default), POST, PUT, DELETE, HEAD, or PATCH.
  • configuration[url] (required) — URL of the source GitLab instance.
  • configuration[access_token] (required) — Access token for the source GitLab instance.
  • entities[source_type] (required) — Array of source entity types: group_entity or project_entity.
  • entities[source_full_path] (required) — Array of source entity paths relative to the source instance, without the URL.
  • entities[destination_namespace] (required) — Array of destination namespaces, as a name or slash-separated path.
  • entities[destination_slug] — Array of destination slugs; use this instead of the deprecated destination_name.
  • entities[destination_name] — Deprecated array of destination slugs; use destination_slug instead.
  • entities[migrate_projects] — Array of booleans indicating whether group imports include nested projects; defaults to true.
  • entities[migrate_memberships] — Array of booleans indicating whether memberships are migrated; defaults to true.

Output shape

A single API response from the bulk import request.

The request path is fixed to /api/v4/bulk_imports. The operation properties do not specify a response schema.

Examples

Example 1: Start importing a project

Set the source GitLab URL and access token, use project_entity as the source type, provide the project's relative path and destination namespace, and optionally set a destination slug.

Example 2: Start importing a group with its projects

Set the source GitLab URL and access token, use group_entity, provide the group's relative path and destination namespace, and leave migrate_projects at its default true to include nested projects.

Links

Discussion