diff options
Diffstat (limited to 'doc/api')
| -rw-r--r-- | doc/api/README.md | 1 | ||||
| -rw-r--r-- | doc/api/project_remote_mirrors.md | 24 |
2 files changed, 25 insertions, 0 deletions
diff --git a/doc/api/README.md b/doc/api/README.md index 89069fe60e1..f14b4a6e53e 100644 --- a/doc/api/README.md +++ b/doc/api/README.md @@ -52,6 +52,7 @@ The following API resources are available in the project context: | [Project-level variables](project_level_variables.md) | `/projects/:id/variables` | | [Project import/export](project_import_export.md) | `/projects/:id/export`, `/projects/import`, `/projects/:id/import` | | [Project milestones](milestones.md) | `/projects/:id/milestones` | +| [Project remote mirrors](project_remote_mirrors.md) | `/projects/:id/remote_mirrors` | | [Project snippets](project_snippets.md) | `/projects/:id/snippets` | | [Project templates](project_templates.md) | `/projects/:id/templates` | | [Protected branches](protected_branches.md) | `/projects/:id/protected_branches` | diff --git a/doc/api/project_remote_mirrors.md b/doc/api/project_remote_mirrors.md new file mode 100644 index 00000000000..bcf268bd421 --- /dev/null +++ b/doc/api/project_remote_mirrors.md @@ -0,0 +1,24 @@ +# Project remote mirrors API + +> [Introduced](https://gitlab.com/gitlab-org/gitlab-ce/issues/54574) in GitLab 11.8 + +A project's remote mirrors are its push mirrors. Remote mirrors are not pull mirrors. + +There is +[an issue](https://gitlab.com/gitlab-org/gitlab-ce/issues/51763) +to improve the naming of push and pull mirrors. + +## Delete remote mirror + +Deletes an existing project remote mirror. This returns a `204 No Content` status code if the operation was successful or `404` if the resource was not found. + +``` +DELETE /projects/:id/remote_mirrors/:remote_mirror_id +``` + +| 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 | +| `remote_mirror_id` | integer | yes | The id of the project's remote mirror | + + |