2020-06-08 14:08:27 -04:00
---
type: reference
stage: Manage
group: Import
2020-11-26 01:09:20 -05:00
info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments
2020-06-08 14:08:27 -04:00
---
2021-10-12 14:12:42 -04:00
2021-06-01 17:10:06 -04:00
# Group import/export **(FREE)**
2020-04-21 14:09:31 -04:00
2021-08-30 14:10:36 -04:00
> [Introduced](https://gitlab.com/groups/gitlab-org/-/epics/2888) in GitLab 13.0 as an experimental feature. May change in future releases.
2020-04-21 14:09:31 -04:00
2021-11-23 22:12:33 -05:00
You can export groups, with all their related data, from one GitLab instance to another.
You can also [export projects ](../../project/settings/import_export.md ).
2020-04-21 14:09:31 -04:00
2021-11-23 22:12:33 -05:00
## Enable export for a group
2020-04-21 14:09:31 -04:00
2021-11-23 22:12:33 -05:00
Prerequisite:
2020-04-21 14:09:31 -04:00
2021-11-23 22:12:33 -05:00
- You must have the [Owner role ](../../permissions.md ) for the group.
2020-04-21 14:09:31 -04:00
2021-11-23 22:12:33 -05:00
To enable import and export for a group:
2020-04-21 14:09:31 -04:00
2021-08-26 05:11:15 -04:00
1. On the top bar, select **Menu > Admin** .
2021-10-12 14:12:42 -04:00
1. On the left sidebar, select **Settings > General** .
1. Expand **Visibility and access controls** .
1. In the **Import sources** section, select the checkboxes for the sources you want.
2020-04-21 14:09:31 -04:00
## Important Notes
Note the following:
2021-05-17 17:10:42 -04:00
- Exports are stored in a temporary directory and are deleted every 24 hours by a specific worker.
2020-04-21 14:09:31 -04:00
- To preserve group-level relationships from imported projects, run the Group Import/Export first, to allow projects to
be imported into the desired group structure.
- Imported groups are given a `private` visibility level, unless imported into a parent group.
2020-08-09 17:10:01 -04:00
- If imported into a parent group, a subgroup inherits the same level of visibility unless otherwise restricted.
2020-04-21 14:09:31 -04:00
- To preserve the member list and their respective permissions on imported groups, review the users in these groups. Make
sure these users exist before importing the desired groups.
2021-10-28 05:13:54 -04:00
### Exported contents
2020-04-21 14:09:31 -04:00
2020-08-09 17:10:01 -04:00
The following items are exported:
2020-04-21 14:09:31 -04:00
- Milestones
- Labels
- Boards and Board Lists
- Badges
- Subgroups (including all the aforementioned data)
- Epics
- Events
2021-11-02 14:12:13 -04:00
- [Wikis ](../../project/wiki/group.md )
([Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/53247) in GitLab 13.9)
2020-04-21 14:09:31 -04:00
2020-08-09 17:10:01 -04:00
The following items are **not** exported:
2020-04-21 14:09:31 -04:00
- Projects
2020-09-13 23:09:21 -04:00
- Runner tokens
2020-04-21 14:09:31 -04:00
- SAML discovery tokens
2020-12-04 16:09:29 -05:00
NOTE:
2020-04-21 14:09:31 -04:00
For more details on the specific data persisted in a group export, see the
2021-06-08 14:10:23 -04:00
[`import_export.yml` ](https://gitlab.com/gitlab-org/gitlab/-/blob/master/lib/gitlab/import_export/group/import_export.yml ) file.
2020-04-21 14:09:31 -04:00
2021-07-27 17:09:42 -04:00
## Export a group
2020-04-21 14:09:31 -04:00
2021-10-06 17:12:16 -04:00
WARNING:
This feature will be [deprecated ](https://gitlab.com/groups/gitlab-org/-/epics/4619 )
in GitLab 14.6 and replaced by [GitLab Migration ](../import/ ).
2021-11-23 22:12:33 -05:00
Prerequisites:
- You must have the [Owner role ](../../permissions.md ) for the group.
To export the contents of a group:
2020-04-21 14:09:31 -04:00
2021-10-12 14:12:42 -04:00
1. On the top bar, select **Menu > Groups** and find your group.
1. On the left sidebar, select **Settings > General** .
1. In the **Advanced** section, select **Export Group** .
2021-06-28 14:08:39 -04:00
1. After the export is generated, you should receive an email with a link to the [exported contents ](#exported-contents )
2021-04-30 14:10:09 -04:00
in a compressed tar archive, with contents in NDJSON format.
2021-07-27 17:09:42 -04:00
1. Alternatively, you can download the export from the UI:
2020-05-13 23:07:52 -04:00
2021-07-27 17:09:42 -04:00
1. Return to your group's **Settings > General** page.
2021-10-12 14:12:42 -04:00
1. In the **Advanced** section, select **Download export** .
You can also generate a new file by selecting **Regenerate export** .
2020-04-21 14:09:31 -04:00
2020-12-04 16:09:29 -05:00
NOTE:
2021-01-13 16:11:00 -05:00
The maximum import file size can be set by the Administrator, default is `0` (unlimited).
2021-01-19 19:10:39 -05:00
As an administrator, you can modify the maximum import file size. To do so, use the `max_import_size` option in the [Application settings API ](../../../api/settings.md#change-application-settings ) or the [Admin UI ](../../admin_area/settings/account_and_limit_settings.md ). Default [modified ](https://gitlab.com/gitlab-org/gitlab/-/issues/251106 ) from 50MB to 0 in GitLab 13.8.
2020-06-09 11:08:05 -04:00
2021-11-23 22:12:33 -05:00
You can also use the [group import/export API ](../../../api/group_import_export.md ).
2020-05-15 11:08:04 -04:00
### Between CE and EE
You can export groups from the [Community Edition to the Enterprise Edition ](https://about.gitlab.com/install/ce-or-ee/ ) and vice versa.
2021-06-28 08:38:12 -04:00
The Enterprise Edition retains some group data that isn't part of the Community Edition. If you're exporting a group from the Enterprise Edition to the Community Edition, you may lose this data. For more information, see [downgrading from EE to CE ](../../../index.md ).
2020-05-15 11:08:04 -04:00
2020-06-16 08:09:00 -04:00
## Importing the group
2021-10-12 14:12:42 -04:00
1. Create a new group:
- On the top bar, select **New** (**{plus}**) and then **New group** .
- On an existing group's page, select the **New subgroup** button.
2020-06-16 08:09:00 -04:00
2021-10-12 14:12:42 -04:00
1. Select **Import group** .
2020-06-16 08:09:00 -04:00
1. Enter your group name.
1. Accept or modify the associated group URL.
2021-10-12 14:12:42 -04:00
1. Select **Choose file** .
2021-07-27 17:09:42 -04:00
1. Select the file that you exported in the [Export a group ](#export-a-group ) section.
2021-10-12 14:12:42 -04:00
1. To begin importing, select **Import group** .
2020-06-16 08:09:00 -04:00
2021-10-12 14:12:42 -04:00
Your newly imported group page appears after the operation completes.
2020-06-16 08:09:00 -04:00
2021-11-12 19:11:03 -05:00
## Automate group and project import **(PREMIUM)**
For information on automating user, group, and project import API calls, see
[Automate group and project import ](../../project/import/index.md#automate-group-and-project-import ).
2020-05-15 11:08:04 -04:00
## Version history
2021-04-30 20:10:00 -04:00
### 14.0+
In GitLab 14.0, the JSON format is no longer supported for project and group exports. To allow for a
transitional period, you can still import any JSON exports. The new format for imports and exports
is NDJSON.
### 13.0+
2020-05-15 11:08:04 -04:00
GitLab can import bundles that were exported from a different GitLab deployment.
This ability is limited to two previous GitLab [minor ](../../../policy/maintenance.md#versioning )
releases, which is similar to our process for [Security Releases ](../../../policy/maintenance.md#security-releases ).
For example:
| Current version | Can import bundles exported from |
|-----------------|----------------------------------|
| 13.0 | 13.0, 12.10, 12.9 |
| 13.1 | 13.1, 13.0, 12.10 |
2020-04-21 14:09:31 -04:00
## Rate Limits
2020-12-15 16:09:53 -05:00
To help avoid abuse, by default, users are rate limited to:
2020-04-21 14:09:31 -04:00
2020-06-03 08:08:21 -04:00
| Request Type | Limit |
| ---------------- | ---------------------------------------- |
2020-12-15 16:09:53 -05:00
| Export | 6 groups per minute |
| Download export | 1 download per group per minute |
| Import | 6 groups per minute |
2021-07-23 14:10:06 -04:00
GitLab.com may have [different settings ](../../gitlab_com/index.md#importexport ) from the defaults.