diff options
| author | Travis Miller <travis@travismiller.com> | 2017-12-05 22:27:23 -0600 |
|---|---|---|
| committer | Travis Miller <travis@travismiller.com> | 2018-02-28 20:47:36 -0600 |
| commit | 812a2c193b8c92e9bd5e640e806df9cbe929e9d6 (patch) | |
| tree | d767c12628bd4c66144d3e720933a6a13af7d6a1 /doc | |
| parent | ec2e54b36347e9817e7b0caa0c095a100e1e8c93 (diff) | |
| download | gitlab-ce-812a2c193b8c92e9bd5e640e806df9cbe929e9d6.tar.gz | |
Add project export API documentation
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/api/project_import_export.md | 78 |
1 files changed, 78 insertions, 0 deletions
diff --git a/doc/api/project_import_export.md b/doc/api/project_import_export.md index e442442c750..7c2c619b97b 100644 --- a/doc/api/project_import_export.md +++ b/doc/api/project_import_export.md @@ -4,6 +4,84 @@ [See also the project import/export documentation](../user/project/settings/import_export.md) +## Export start + +Start a new export. + +```http +POST /projects/:id/export +``` + +| 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 --request POST --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" https://gitlab.example.com/api/v4/projects/1/export +``` + +```json +{ + "message": "202 Accepted" +} +``` + +## Export status + +Get the status of export. + +```http +GET /projects/:id/export +``` + +| 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/export +``` + +Status can be one of `none`, `started`, or `finished`. + +```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", + "export_status": "finished", + "_links": { + "api_url": "https://gitlab.example.com/api/v4/projects/1/export/download", + "web_url": "https://gitlab.example.com/gitlab-org/gitlab-test/download_export", + } +} +``` + +## Export download + +Download the finished export. + +```http +GET /projects/:id/export +``` + +| 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" --remote-header-name --remote-name https://gitlab.example.com/api/v4/projects/5/export/download +``` + +```console +ls *export.tar.gz +2017-12-05_22-11-148_namespace_project_export.tar.gz +``` + ## Import a file ```http |