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

Updating the Basic Settings of a Repository Group

Function

This API is used to update the basic settings 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:group:setGroup

Write

-

-

-

-

URI

PUT https://{hostURL}/v4/groups/{group_id}/general-policy

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
Table 3 Request body parameters

Parameter

Mandatory

Type

Description

disable_fork

No

Boolean

Definition:

Whether to disable fork.

branch_name_regex

No

String

Definition:

Regular expression of the branch name

Value range:

1–1,000 characters.

tag_name_regex

No

String

Definition:

Regular expression of the tag name

Value range:

1–1,000 characters.

generate_pre_merge_ref

No

Boolean

Definition:

Generate a merge request for pre-merging

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

disable_fork

Boolean

Definition:

Whether to disable fork.

branch_name_regex

String

Definition:

Regular expression of the branch name

Value range:

1–1,000 characters.

tag_name_regex

String

Definition:

Regular expression of the tag name

Value range:

1–1,000 characters.

generate_pre_merge_ref

Boolean

Definition:

Generate a merge request for pre-merging

Example Requests

Update the basic settings of a repository group

PUT https://{endpoint}/v4/groups/{group_id}/general-policy

{
  "disable_fork" : false,
  "branch_name_regex" : null,
  "tag_name_regex" : null,
  "generate_pre_merge_ref" : false
}

Example Responses

Status code: 200

Basic settings of a project

{
  "disable_fork" : false,
  "branch_name_regex" : null,
  "tag_name_regex" : null,
  "generate_pre_merge_ref" : false
}

Status Codes

Status Code

Description

200

Basic settings of a project

Error Codes

See Error Codes.

Parent topic: Group