List all GitLab Migrations' entities

GET /bulk_imports/entities

This feature was introduced in GitLab 14.1.

Query parameters

  • page integer(int32)

    Current page number

    Default value is 1.

  • per_page integer(int32)

    Number of items per page

    Default value is 20.

  • sort string

    Return GitLab Migrations sorted in created by asc or desc order.

    Values are asc or desc. Default value is desc.

  • status string

    Return all GitLab Migrations' entities with specified status

    Values are created, started, finished, timeout, or failed.

Responses

  • 200 application/json

    List all GitLab Migrations' entities

    Hide response attributes Show response attributes object
    • id integer(int32)
    • bulk_import_id integer(int32)
    • status string

      Values are created, started, finished, timeout, or failed.

    • entity_type string

      Values are group or project.

    • source_full_path string
    • destination_full_path string
    • destination_name string
    • destination_slug string
    • destination_namespace string
    • parent_id integer(int32)
    • namespace_id integer(int32)
    • project_id integer(int32)
    • created_at string(date-time)
    • updated_at string(date-time)
    • failures array[object]
      Hide failures attributes Show failures attributes object
      • relation string
      • step string
      • exception_message string
      • exception_class string
      • correlation_id_value string
      • created_at string(date-time)
      • pipeline_class string
      • pipeline_step string
    • migrate_projects boolean
  • 401

    Unauthorized

  • 404

    Not found

  • 503

    Service unavailable

GET /bulk_imports/entities
curl \
 --request GET 'https://www.gitlab.com/api/v4/bulk_imports/entities' \
 --header "Private-Token: $API_KEY"
Response examples (200)
[
  {
    "id": 1,
    "bulk_import_id": 1,
    "status": "created",
    "entity_type": "group",
    "source_full_path": "source_group",
    "destination_full_path": "some_group/source_project",
    "destination_name": "destination_slug",
    "destination_slug": "destination_slug",
    "destination_namespace": "destination_path",
    "parent_id": 1,
    "namespace_id": 1,
    "project_id": 1,
    "created_at": "2012-05-28T04:42:42-07:00",
    "updated_at": "2012-05-28T04:42:42-07:00",
    "failures": [
      {
        "relation": "group",
        "step": "extractor",
        "exception_message": "error message",
        "exception_class": "Exception",
        "correlation_id_value": "dfcf583058ed4508e4c7c617bd7f0edd",
        "created_at": "2012-05-28T04:42:42-07:00",
        "pipeline_class": "BulkImports::Groups::Pipelines::GroupPipeline",
        "pipeline_step": "extractor"
      }
    ],
    "migrate_projects": true
  }
]