GIgitlab
groups

Archive a group

Archives a specified group. You must be an administrator or have the Owner role for the group.

post/api/v4/groups/{id}/archive

Request

  • Base URL
    https://gitlab.com
  • Auth
    none declared

Path parameters

idstring required

The ID of a group

Response

Archive a group

idinteger required
web_urlstring required
namestring required
pathstring required
descriptionstring required
visibilitystring required
share_with_group_lockboolean required
require_two_factor_authenticationboolean required
two_factor_grace_periodinteger required
project_creation_levelstring required
auto_devops_enabledstring required
subgroup_creation_levelstring required
emails_disabledboolean required
emails_enabledboolean required
show_diff_preview_in_emailboolean required
mentions_disabledstring required
lfs_enabledboolean required
archivedboolean required
math_rendering_limits_enabledboolean required
lock_math_rendering_limits_enabledboolean required
crm_enabledboolean required
resource_access_token_notify_inheritedboolean required
lock_resource_access_token_notify_inheritedboolean required
default_branchstring required
default_branch_protectioninteger required
default_branch_protection_defaultsstring required
avatar_urlstring required
request_access_enabledboolean required
full_namestring required
full_pathstring required
created_atstring required
parent_idstring required
organization_idinteger required
shared_runners_settingstring required
max_artifacts_sizeinteger required
marked_for_deletion_onstring required
ldap_cnstring required
ldap_accessstring required
file_template_project_idstring
wiki_access_levelstring required
repository_storagestring
duo_core_features_enabledboolean

[Experimental] Indicates whether GitLab Duo Core features are enabled for the group

duo_features_enabledstring
lock_duo_features_enabledstring
auto_duo_code_review_enabledstring
web_based_commit_signing_enabledstring
allow_personal_snippetsstring
duo_namespace_access_rulesstring
built_in_project_templates_enabledboolean
lock_built_in_project_templates_enabledboolean

Example response

{
  "web_url": "http://gitlab.example.com/groups/diaspora",
  "name": "Diaspora",
  "custom_attributes": {
    "key": "foo",
    "value": "bar"
  },
  "ldap_group_links": {
    "cn": "ldap-group-1",
    "group_access": 10,
    "provider": "ldapmain",
    "filter": "id >= 500",
    "member_role_id": 12
  },
  "saml_group_links": {
    "name": "saml-group-1",
    "access_level": 40,
    "member_role_id": 12,
    "provider": "saml"
  }
}

Changes

No recorded changes to this operation across all 5 revisions of this API.