Updating Basic Settings of a Project

Function

This API is used to update basic project settings.

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/projects/{project_id}/general-policy

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Definition You can call the API used to query project list to query the project list to obtain the unique 32-character UUID of the project. Range A string that can contain 32 characters.

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	Definition User token. You can obtain the token by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is the user token. Constraints N/A Range A string that can contain 1 to 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 basic project settings

PUT https://{endpoint}/v4/projects/3132f98fb2c44430ba68f356af3a8e0d/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: Project

Previous topic: Obtaining Basic Settings of a Specified Project

Next topic: Obtaining the Basic Settings of a Specified Project

Feedback

Was this page helpful?

Helpful Not helpful

Provide feedback

Thank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.

The system is busy. Please try again later.

For any further questions, feel free to contact us through the chatbot.

Chatbot