diff options
| author | GitLab Bot <gitlab-bot@gitlab.com> | 2020-01-24 15:09:01 +0300 |
|---|---|---|
| committer | GitLab Bot <gitlab-bot@gitlab.com> | 2020-01-24 15:09:01 +0300 |
| commit | 2c2dd5e36c4ed5f09f488be288882d98f9124d12 (patch) | |
| tree | ad4c478bb1c588387a881b26a7db7c3237b9d4f3 /doc/api/groups.md | |
| parent | 2ff184ad761fbfbe25a3d827c8f704349963a8d2 (diff) | |
Add latest changes from gitlab-org/gitlab@master
Diffstat (limited to 'doc/api/groups.md')
| -rw-r--r-- | doc/api/groups.md | 30 |
1 files changed, 26 insertions, 4 deletions
diff --git a/doc/api/groups.md b/doc/api/groups.md index de8490fa1f4..156dda52ab0 100644 --- a/doc/api/groups.md +++ b/doc/api/groups.md @@ -628,7 +628,12 @@ Feature.disable(:limit_projects_in_groups_api) ## Remove group -Removes group with all projects inside. Only available to group owners and administrators. +Only available to group owners and administrators. + +This endpoint either: + +- Removes group, and queues a background job to delete all projects in the group as well. +- Since GitLab 12.8, on [Premium](https://about.gitlab.com/pricing/premium/) or higher tiers, marks a group for deletion. The deletion will happen 7 days later by default, but this can be changed in the [instance settings](../user/admin_area/settings/visibility_and_access_controls.md#default-deletion-adjourned-period-premium-only). ``` DELETE /groups/:id @@ -636,10 +641,27 @@ DELETE /groups/:id Parameters: -- `id` (required) - The ID or path of a user group +| Attribute | Type | Required | Description | +| --------------- | -------------- | -------- | ----------- | +| `id` | integer/string | yes | The ID or [URL-encoded path of the group](README.md#namespaced-path-encoding) | + +The response will be `202 Accepted` if the user has authorization. + +## Restore group marked for deletion **(PREMIUM)** + +> [Introduced](https://gitlab.com/gitlab-org/gitlab/issues/33257) in GitLab 12.8. + +Restores a group marked for deletion. + +```plaintext +POST /groups/:id/restore +``` + +Parameters: -This will queue a background job to delete all projects in the group. The -response will be a 202 Accepted if the user has authorization. +| Attribute | Type | Required | Description | +| --------------- | -------------- | -------- | ----------- | +| `id` | integer/string | yes | The ID or [URL-encoded path of the group](README.md#namespaced-path-encoding) | ## Search for group |