2018-02-13 14:04:19 +00:00
|
|
|
# Project import API
|
|
|
|
|
|
|
|
[Introduced][ce-41899] in GitLab 10.6
|
|
|
|
|
2018-02-16 13:37:26 +00:00
|
|
|
[See also the project import/export documentation](../user/project/settings/import_export.md)
|
2018-02-13 14:04:19 +00:00
|
|
|
|
|
|
|
## Import a file
|
|
|
|
|
|
|
|
```http
|
|
|
|
POST /projects/import
|
|
|
|
```
|
|
|
|
|
|
|
|
| Attribute | Type | Required | Description |
|
|
|
|
| --------- | -------------- | -------- | ---------------------------------------- |
|
2018-02-16 13:37:26 +00:00
|
|
|
| `namespace` | integer/string | no | The ID or path of the namespace that the project will be imported to. Defaults to the current user's namespace |
|
2018-02-13 14:04:19 +00:00
|
|
|
| `file` | string | yes | The file to be uploaded |
|
|
|
|
| `path` | string | yes | Name and path for new project |
|
|
|
|
|
|
|
|
To upload a file from your filesystem, use the `--form` argument. This causes
|
|
|
|
cURL to post data using the header `Content-Type: multipart/form-data`.
|
|
|
|
The `file=` parameter must point to a file on your filesystem and be preceded
|
|
|
|
by `@`. For example:
|
|
|
|
|
|
|
|
```console
|
2018-02-14 13:55:11 +00:00
|
|
|
curl --request POST --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" --form "path=api-project" --form "file=@/path/to/file" https://gitlab.example.com/api/v4/projects/import
|
2018-02-13 14:04:19 +00:00
|
|
|
```
|
|
|
|
|
|
|
|
```json
|
|
|
|
{
|
|
|
|
"id": 1,
|
|
|
|
"description": null,
|
|
|
|
"name": "api-project",
|
|
|
|
"name_with_namespace": "Administrator / api-project",
|
|
|
|
"path": "api-project",
|
|
|
|
"path_with_namespace": "root/api-project",
|
|
|
|
"created_at": "2018-02-13T09:05:58.023Z",
|
|
|
|
"import_status": "scheduled"
|
|
|
|
}
|
|
|
|
```
|
|
|
|
|
|
|
|
## Import status
|
|
|
|
|
2018-02-13 14:12:18 +00:00
|
|
|
Get the status of an import.
|
2018-02-13 14:04:19 +00:00
|
|
|
|
|
|
|
```http
|
|
|
|
GET /projects/:id/import
|
|
|
|
```
|
|
|
|
|
|
|
|
| Attribute | Type | Required | Description |
|
|
|
|
| --------- | -------------- | -------- | ---------------------------------------- |
|
|
|
|
| `id` | integer/string | yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user |
|
|
|
|
|
|
|
|
```console
|
|
|
|
curl --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" https://gitlab.example.com/api/v4/projects/1/import
|
|
|
|
```
|
|
|
|
|
2018-02-13 14:12:18 +00:00
|
|
|
Status can be one of `none`, `scheduled`, `failed`, `started`, or `finished`.
|
|
|
|
|
2018-02-16 13:37:26 +00:00
|
|
|
If the status is `failed`, it will include the import error message under `import_error`.
|
2018-02-13 14:04:19 +00:00
|
|
|
|
|
|
|
```json
|
|
|
|
{
|
|
|
|
"id": 1,
|
|
|
|
"description": "Itaque perspiciatis minima aspernatur corporis consequatur.",
|
|
|
|
"name": "Gitlab Test",
|
|
|
|
"name_with_namespace": "Gitlab Org / Gitlab Test",
|
|
|
|
"path": "gitlab-test",
|
|
|
|
"path_with_namespace": "gitlab-org/gitlab-test",
|
|
|
|
"created_at": "2017-08-29T04:36:44.383Z",
|
|
|
|
"import_status": "started"
|
|
|
|
}
|
|
|
|
```
|
|
|
|
|
|
|
|
[ce-41899]: https://gitlab.com/gitlab-org/gitlab-ce/issues/41899
|