Start a group or project migration

POST

/api/v4/bulk_imports

• GitLab REST API

Starts a group or project migration. To migrate a project, specify entities[project_entity].

Authorizations

• http
• oauth2

Request Body ^required

Media type application/x-www-form-urlencoded

object

configuration

required

The source GitLab instance configuration

object

url

required

Source GitLab instance URL

string

nullable

access_token

required

Access token to the source GitLab instance

string

nullable

entities

required

List of entities to import

Array<object>

nullable

object

source_type

required

Source entity type

string

>= 1 characters

Allowed values: group_entity project_entity

source_full_path

required

Relative path of the source entity to import

string

nullable

Example

'source/full/path' not 'https://example.com/source/full/path'

destination_namespace

required

Destination namespace for the entity

string

nullable

Example

'destination_namespace' or 'destination/namespace'

destination_slug

Destination slug for the entity

string

nullable

Example

'destination_slug' not 'destination/slug'

destination_name

Deprecated: Use :destination_slug instead. Destination slug for the entity

string

nullable

Example

'destination_slug' not 'destination/slug'

migrate_projects

Indicates group migration should include nested projects

boolean

default: true nullable

migrate_memberships

The option to migrate memberships or not

boolean

default: true nullable

Responses

201

Created

Media type application/json

object

id

integer format: int64

status

string

source_type

string

source_url

string

created_at

string format: date-time

updated_at

string format: date-time

has_failures

boolean

Example

{
  "id": 1,
  "status": "finished",
  "source_type": "gitlab",
  "source_url": "https://source.gitlab.com/",
  "created_at": "2012-05-28T04:42:42-07:00",
  "updated_at": "2012-05-28T04:42:42-07:00",
  "has_failures": false
}

400

Bad request

401

Unauthorized

404

Not found

422

Unprocessable entity

503

Service unavailable