Help Center/ CodeArts Repo/ API Reference/ APIs/ V4/ Group/ Obtaining the Inheritance Settings of a Repository Group
Updated on 2026-01-27 GMT+08:00
View PDF
Share

Obtaining the Inheritance Settings of a Repository Group

Function

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

Debugging

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

Authorization Information

Each account root user has all the permissions required to call all APIs, but IAM users must be assigned the following required identity policy-based permissions. For details about the required permissions, see Permissions Policies and Supported Actions.

Action

Access Level

Resource Type (*: required)

Condition Key

Alias

Dependencies

codeartsrepo::getProjectSetting

Read

-

codeartsrepo:ProjectId

-

-

URI

GET https://{hostURL}/v4/groups/{group_id}/settings-inherit-cfg

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.

Default Value

N/A

Value range:

1~2147483647

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Definition

User token. Obtain one by calling the IAM API Obtaining a User Token. The value of X-Subject-Token in the response header is a token.

Constraints

N/A

Range

1–100,000 characters.

Default Value

N/A

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

can_update

Boolean

Definition

Whether it is available.

id

Integer

Definition

Record ID.

Value range:

1~2147483647

product_id

String

Definition

Project ID.

Range

1–1,000 characters.

namespace_id

Integer

Definition

Repository group ID.

Value range:

1~2147483647

parent_id

Integer

Definition

Parent ID.

Value range:

1~2147483647

ownership

Integer

Definition

Order ID.

Value range:

1~2147483647

pbi

Integer

Definition

Order ID.

Value range:

1~2147483647

protected_branches

Integer

Definition

Protected branch policy.

Value range:

1~2147483647

protected_tags

Integer

Definition

Tag protection policy.

Value range:

1~2147483647

push_rules

Integer

Definition

Push rule policy.

Value range:

1~2147483647

change_requests

Integer

Definition

CR policy.

Value range:

1~2147483647

custom_ctrl_items

Integer

Definition

Order ID.

Value range:

1~2147483647

reviews

Integer

Definition

Order ID.

Value range:

1~2147483647

issues

Integer

Definition

Issue inheritance mode.

Value range:

1~2147483647

cr_evaluation

Integer

Definition

Order ID.

Value range:

1~2147483647

e2e_settings

Integer

Definition

E2E policy.

Value range:

1~2147483647

committer_settings

Integer

Definition

Commit policy.

Value range:

1~2147483647

webhook_settings

Integer

Definition

Webhook policy.

Value range:

1~2147483647

stream_event_settings

Integer

Definition

Order ID.

Value range:

1~2147483647

pipeline_settings

Integer

Definition

Order ID.

Value range:

1~2147483647

issue_templates

Integer

Definition

Issue template inheritance mode.

Value range:

1~2147483647

cr_comment_templates

Integer

Definition:

Order ID

Value range:

1~2147483647

merge_requests

Integer

Definition

Order ID.

Value range:

1~2147483647

mr_branch_policies

Integer

Definition

Merge request policy.

Value range:

1~2147483647

repository_settings

Integer

Definition

Repository policy.

Value range:

1~2147483647

deploy_keys

Integer

Definition:

Deploy key policy

Value range:

1~2147483647

watermark

Integer

Definition

Watermark policy.

Value range:

1~2147483647

created_at

String

Definition

Creation time.

update_at

String

Definition

Update time.

Status code: 401

Table 4 Response body parameters

Parameter

Type

Description

error_code

String

Definition

Error code.

error_msg

String

Definition

Error message.

Status code: 403

Table 5 Response body parameters

Parameter

Type

Description

error_code

String

Definition

Error code.

error_msg

String

Definition

Error message.

Status code: 404

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

Definition

Error code.

error_msg

String

Definition

Error message.

Example Requests

GET https://{endpoint}/v4/groups/{group_id}/settings-inherit-cfg

Example Responses

Status code: 200

Get Group Inheritance Settings

{
  "can_update" : null,
  "id" : 352996,
  "product_id" : null,
  "namespace_id" : 2111918419,
  "parent_id" : 0,
  "ownership" : 0,
  "pbi" : 0,
  "protected_branches" : 1000,
  "protected_tags" : 1003,
  "push_rules" : 1000,
  "change_requests" : 0,
  "custom_ctrl_items" : 0,
  "reviews" : 0,
  "issues" : 0,
  "cr_evaluation" : 0,
  "e2e_settings" : 1000,
  "committer_settings" : 0,
  "webhook_settings" : 1000,
  "stream_event_settings" : 0,
  "pipeline_settings" : 0,
  "issue_templates" : 0,
  "cr_comment_templates" : 0,
  "merge_requests" : 1000,
  "mr_branch_policies" : 1000,
  "repository_settings" : 1000,
  "deploy_keys" : 1000,
  "watermark" : 1000,
  "created_at" : "2025-05-22 22:43:07 +0800",
  "update_at" : "2025-05-22 22:43:07 +0800"
}

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: 404

Not Found

{
  "error_code" : "CH.004404",
  "error_msg" : "Group Not Found. Group Not Found"
}

Status Codes

Status Code

Description

200

Get Group Inheritance Settings

401

Unauthorized

403

Bad Request

404

Not Found

Error Codes

See Error Codes.

Parent topic: Group