Help Center/ CodeArts Repo/ API Reference/ APIs/ V4/ Repository/ Modifying the Common Commit Rules of a Repository

Updated on 2026-01-27 GMT+08:00

View PDF

Modifying the Common Commit Rules of a Repository

Function

This API is used to modify the general commit rules of a repository.

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:repository:setRepository	Write	-	-	-	-

URI

PUT https://{hostURL}/v4/repositories/{repository_id}/general-commit-rule

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
repository_id	Yes	Integer	Definition You can query the project list to obtain the repository ID by calling the API used to query user's all repositories. Constraints N/A 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
reject_unsigned_commits	No	Boolean	Definition: Whether to reject non-signed-off-by commits. Constraints: N/A Value range: true: yes false: no Default value: N/A
reject_not_signed_by_gpg	No	Boolean	Definition: Whether to reject commits not signed by GPG. Constraints: N/A Value range: true: yes false: no Default value: N/A
deny_delete_tag	No	Boolean	Definition: Whether tags can be deleted. Constraints: N/A Value range: true: Tags cannot be deleted. false: Tags can be deleted. Default value: N/A
prevent_secrets	No	Boolean	Definition: Whether to prevent committing secrets. Constraints: N/A Value range: true: The submission of confidential files is blocked. false: The submission of confidential files is allowed. Default value: N/A
deny_force_push	No	Boolean	Definition: Whether to disable force push. Constraints: N/A Value range: true: Force push is disabled. false: Force push is allowed. Default value: N/A

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
reject_unsigned_commits	Boolean	Definition: Whether to reject non-signed-off-by commits. Constraints: N/A. Value range: true: Yes. false: No. Default value: N/A.
reject_not_signed_by_gpg	Boolean	Definition: Whether to reject commits not signed by GPG. Constraints: N/A. Value range: true: Yes. false: No. Default value: N/A.
deny_delete_tag	Boolean	Definition: Whether tags can be deleted. Constraints: N/A. Value range: true: Tags cannot be deleted. false: Tags can be deleted. Default value: N/A.
prevent_secrets	Boolean	Definition: Whether to prevent committing secrets. Constraints: N/A. Value range: true: Yes. false: No. Default value: N/A.
deny_force_push	Boolean	Definition: Whether to disable forcible push. Constraints: N/A. Value range: true: Yes. false: No. Default value: N/A.

Example Requests

Modify general commit rules of the repository

PUT /v4/repositories/{repository_id}/general-commit-rule

{
  "reject_unsigned_commits" : true,
  "reject_not_signed_by_gpg" : true,
  "deny_delete_tag" : true,
  "prevent_secrets" : true,
  "deny_force_push" : true
}

Example Responses

Status code: 200

General commit rules of the repository

{
  "reject_unsigned_commits" : true,
  "reject_not_signed_by_gpg" : true,
  "deny_delete_tag" : true,
  "prevent_secrets" : true,
  "deny_force_push" : true
}