Obtaining the Inheritance Settings of a Repository Group

This API is used to obtain the inheritance settings of a repository group.

You can debug this API through automatic authentication in API Explorer or use the SDK sample code generated by API Explorer.

GET https://{hostURL}/v4/groups/{group_id}/inherit

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
group_id	Yes	Integer	Definition Repository group ID, which is the numeric ID next to Group ID on the repository group homepage. Value range: 1~2147483647

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
setting_type	Yes	String	Definition: Mandatory. Setting types. protected_branches: protected branches; protected_tags: protected tags; push_rules: push rules; merge_requests: merge request; mr_branch_policies: merged branches; reviews: review comments; e2e_settings: e2e settings; webhook_settings: hook settings; deploy_keys: deploy keys; watermark: watermark; repository_settings: repository settings. Enumeration values: protected_branches protected_tags push_rules merge_requests mr_branch_policies reviews e2e_settings webhook_settings deploy_keys watermark repository_settings

**Table 3** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	Definition User token. Obtain a token by calling the IAM API for obtaining a user token. The value of X-Subject-Token in the response header is the user token. Constraints Mandatory. Range 1–100,000 characters. Default Value N/A.

Status code: 202

**Table 4** Response body parameters
Parameter	Type	Description
group_id	String	Definition: Repository group ID. Value range: 1 to 1,000 characters.
source_setting	String	Definition: Resource type settings. Value range: 1 to 1,000 characters.
project_id	String	Definition: Project ID. Value range: 1 to 1,000 characters.
upward_inherit_editable	Boolean	Definition: Whether the current setting items can be edited during upward inheritance.

Status code: 401

**Table 5** Response body parameters
Parameter	Type	Description
error_code	String	Definition Error code.
error_msg	String	Definition Error message.

Status code: 403

**Table 6** Response body parameters
Parameter	Type	Description
error_code	String	Definition Error code.
error_msg	String	Definition Error message.

GET https://{endpoint}/v4/groups/{group_id}/inherit?offset=0&limit=20

Status code: 202

Obtain the inheritance settings of a repository group.

{
  "group_id" : 2111919928,
  "source_setting" : "group",
  "project_id" : "c65b44ca43b04961860e728cb91acfc6",
  "upward_inherit_editable" : true
}

Status code: 401

Unauthorized

{
  "error_code" : "DEV.00000003",
  "error_msg" : "Authentication information expired."
}

Status code: 403

Bad Request

{
  "error_code" : "CH.004403",
  "error_msg" : "Insufficient permissions. Apply for the required permissions and try again."
}

Status Code	Description
202	Obtain the inheritance settings of a repository group.
401	Unauthorized
403	Bad Request

Parent topic: Group

Thank you very much for your feedback. We will continue working to improve the documentation.

The system is busy. Please try again later.