diff options
author | Nick Thomas <nick@gitlab.com> | 2018-04-03 18:57:55 +0100 |
---|---|---|
committer | Nick Thomas <nick@gitlab.com> | 2018-04-19 17:25:01 +0100 |
commit | 672733aa66e371edc50f6d1c2467896c40ed9ac8 (patch) | |
tree | f7d5313ab03c496c74ca63a29f786d9db19f79b1 /doc | |
parent | fb46dfb235f452333984891af5bb677f90faf174 (diff) | |
download | gitlab-ce-672733aa66e371edc50f6d1c2467896c40ed9ac8.tar.gz |
Add an API endpoint to download git repository snapshots
Diffstat (limited to 'doc')
-rw-r--r-- | doc/api/projects.md | 25 |
1 files changed, 24 insertions, 1 deletions
diff --git a/doc/api/projects.md b/doc/api/projects.md index 7ffe380e275..fe21dfe23f9 100644 --- a/doc/api/projects.md +++ b/doc/api/projects.md @@ -1398,4 +1398,27 @@ Read more in the [Project Badges](project_badges.md) documentation. ## Issue and merge request description templates -The non-default [issue and merge request description templates](../user/project/description_templates.md) are managed inside the project's repository. So you can manage them via the API through the [Repositories API](repositories.md) and the [Repository Files API](repository_files.md).
\ No newline at end of file +The non-default [issue and merge request description templates](../user/project/description_templates.md) are managed inside the project's repository. So you can manage them via the API through the [Repositories API](repositories.md) and the [Repository Files API](repository_files.md). + +## Download snapshot of a git repository + +> Introduced in GitLab 10.7 + +This endpoint may only be accessed by an administrative user. + +Download a snapshot of the project (or wiki, if requested) git repository. This +snapshot is always in uncompressed [tar](https://en.wikipedia.org/wiki/Tar_(computing)) +format. + +If a repository is corrupted to the point where `git clone` does not work, the +snapshot may allow some of the data to be retrieved. + +``` +GET /projects/:id/snapshot +``` + +| Attribute | Type | Required | Description | +| --------- | ---- | -------- | ----------- | +| `id` | integer/string | yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) | +| `wiki` | boolean | no | Whether to download the wiki, rather than project, repository | + |