Help Center/ CodeArts Repo/ API Reference/ APIs/ V4/ Project/ Updating Project Inheritance Settings
Updated on 2026-04-28 GMT+08:00
View PDF

Updating Project Inheritance Settings

Function

This API is used to update inherited project settings.

Debugging

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

URI

PUT https://{hostURL}/v4/projects/{project_id}/settings-inherit-cfg

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Definition:

You can obtain the unique project identifier, 32-character UUID, by calling the API used to query the project list.

Value range:

32 characters

Request Parameters

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

Parameter

Mandatory

Type

Description

data

No

Array of ProjectSettingsInheritCfgDto objects

Definition:

Inheritance settings

Constraints:

N/A

Value range:

N/A

Default value:

N/A
Table 4 ProjectSettingsInheritCfgDto

Parameter

Mandatory

Type

Description

name

No

String

Definition:

Source type

Constraints:

N/A

Value range:

  • protected_branches: Protected branch settings

  • protected_tags: Protected tag settings

  • repository_settings: Repository settings

  • push_rules: Commit rule settings

  • merge_requests: Merge request settings

  • e2e_settings: E2E settings

  • watermark: Watermark settings

  • webhook_settings: Webhook settings

  • mr_branch_policies: Merge branch policy settings

  • reviews: review settings

  • deploy_keys: deployment parameter settings

Default value:

N/A

Enumeration values:

  • protected_branches

  • protected_tags

  • repository_settings

  • push_rules

  • merge_requests

  • e2e_settings

  • watermark

  • webhook_settings

  • mr_branch_policies

  • reviews

  • deploy_keys

inherit_mod

No

String

Definition:

Inheritance settings

Constraints:

N/A

Value range:

  • force_inherit: force inherit configuration

  • custom: use current configuration

Default value:

N/A

Enumeration values:

  • force_inherit

  • custom

Response Parameters

Status code: 200

Table 5 Response body parameters

Parameter

Type

Description

[items]

Array of ProjectSettingsInheritCfgDto objects

Inherited project settings list
Table 6 ProjectSettingsInheritCfgDto

Parameter

Type

Description

name

String

Definition:

Source type

Constraints:

N/A

Value range:

  • protected_branches: Protected branch settings

  • protected_tags: Protected tag settings

  • repository_settings: Repository settings

  • push_rules: Commit rule settings

  • merge_requests: Merge request settings

  • e2e_settings: E2E settings

  • watermark: Watermark settings

  • webhook_settings: Webhook settings

  • mr_branch_policies: Merge branch policy settings

  • reviews: review settings

  • deploy_keys: deployment parameter settings

Default value:

N/A

Enumeration values:

  • protected_branches

  • protected_tags

  • repository_settings

  • push_rules

  • merge_requests

  • e2e_settings

  • watermark

  • webhook_settings

  • mr_branch_policies

  • reviews

  • deploy_keys

inherit_mod

String

Definition:

Inheritance settings

Constraints:

N/A

Value range:

  • force_inherit: force inherit configuration

  • custom: use current configuration

Default value:

N/A

Enumeration values:

  • force_inherit

  • custom

Example Requests

Update inherited project settings.

PUT https://{endpoint}/v4/projects/3132f98fb2c44430ba68f356af3a8e0d/settings-inherit-cfg

{
  "data" : [ {
    "name" : "protected_branches",
    "inherit_mod" : "inherit"
  }, {
    "name" : "protected_tags",
    "inherit_mod" : "inherit"
  }, {
    "name" : "repository_settings",
    "inherit_mod" : "inherit"
  }, {
    "name" : "push_rules",
    "inherit_mod" : "inherit"
  }, {
    "name" : "merge_requests",
    "inherit_mod" : "inherit"
  }, {
    "name" : "e2e_settings",
    "inherit_mod" : "inherit"
  }, {
    "name" : "watermark",
    "inherit_mod" : "inherit"
  } ]
}

Example Responses

Status code: 200

Inherited project settings list

[ {
  "name" : "protected_branches",
  "inherit_mod" : "custom"
}, {
  "name" : "protected_tags",
  "inherit_mod" : "custom"
}, {
  "name" : "repository_settings",
  "inherit_mod" : "inherit"
}, {
  "name" : "push_rules",
  "inherit_mod" : "inherit"
}, {
  "name" : "merge_requests",
  "inherit_mod" : "inherit"
}, {
  "name" : "e2e_settings",
  "inherit_mod" : "inherit"
}, {
  "name" : "watermark",
  "inherit_mod" : "inherit"
} ]

Status Codes

Status Code

Description

200

Inherited project settings list

Error Codes

See Error Codes.

Parent topic: Project