Help Center/ CodeArts Repo/ API Reference/ APIs/ V4/ Commit/ Creating Commit Information

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

View PDF

Creating Commit Information

Function

This API is used to create commit information.

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:pushCode	Write	-	-	-	-

URI

POST https://{hostURL}/v4/repositories/{repository_id}/repository/commits

**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
branch	Yes	String	Definition Branch name. Range N/A.
commit_message	Yes	String	Definition Commit message. Range N/A.
actions	Yes	Array of ActionDto objects	Definition Operation performed upon commit. Range N/A.
start_branch	No	String	Definition Starts a new commit from this branch. Range N/A.
author_email	No	String	Definition Author's email address. Range N/A.
author_name	No	String	Definition Author name. Range N/A.
stats	No	Boolean	Definition Whether to include commit statistics. Range true: includes commit statistics. false: not include commit statistics. Default value: true
force	No	Boolean	Definition Forcible commit or not. Range true: forcible commit. false: not a forcible commit Default value: false

**Table 4** ActionDto
Parameter	Mandatory	Type	Description
action	Yes	String	Definition Specifies the operation to be performed. Range create, means to create a file. create_dir: means to create a directory. update: means to update. move: means to move. delete: means to delete. chmod: means to change permissions. Enumeration values: create create_dir update move delete chmod
file_path	Yes	String	Definition File path. Range N/A.
previous_path	No	String	Definition Previous path. Range N/A.
content	No	String	Definition File content. Range N/A.
encoding	No	String	Definition Encoding format. Range text. base64. Default value: text
last_commit_id	No	Boolean	Definition Last known file commit ID. Range N/A.
execute_filemode	No	Boolean	Definition Execution file mode. Range true: enable the execute flag on the file. false: disable the execute flag on the file.

Response Parameters

Status code: 201

**Table 5** Response body parameters
Parameter	Type	Description
id	String	id
message	String	Message
parent_ids	Array of strings	Parent node commit ID
authored_date	String	Time when the branch was created.
author_name	String	Creator name
author_email	String	Creator's email.
committed_date	String	Code commit date and time
committer_name	String	Committer name
committer_email	String	Committer email
open_gpg_verified	Boolean	Whether to enable the GPG verification
verification_status	Integer	Verification status Value range: 0~1
gpg_primary_key_id	String	Identifier of the GPG public key
name	String	Username
gpg_nick_name	String	Alias
gpg_tenant_name	String	Tenant name
gpg_user_name	String	Information about a specific GPG user
short_id	String	Short ID
created_at	String	Creation time
title	String	Title
author_avatar_url	String	author_avatar_url
committer_avatar_url	String	committer_avatar_url
relate_url	Array of RelatedCommitSimpleDto objects	only for DevCloud
nick_name	String	Title
tenant_name	String	tenant_name
user_name	String	Username
stats	CommitStatsDto object	Definition Statistics information. Range N/A.
status	String	Pipeline status. pending: queuing; running: running; success: successful; failed: failed; canceled: canceled; skipped: skipped; and timedout: timed out Enumeration values: pending running success failed canceled skipped timedout
last_pipeline	PipelineBasicDto object	Definition Latest pipeline. Range N/A.
project_id	Integer	Definition Repository ID. Range N/A.
merge_request	SimpleMergeRequestDetailDto object	Definition MR information. Range N/A.
code_changes	Array of SimpleDiffDto objects	Definition Code change content. Range N/A.

**Table 6** RelatedCommitSimpleDto
Parameter	Type	Description
related_id	String	Associated work item ID
related_url	String	Associated work item URL

**Table 7** CommitStatsDto
Parameter	Type	Description
additions	Integer	Definition Number of added lines. Range N/A.
deletions	Integer	Definition Number of deleted lines. Range N/A.
total	Integer	Definition Number of changed lines. Range N/A.

**Table 8** PipelineBasicDto
Parameter	Type	Description
id	Integer	Pipeline ID Value range: 1~2147483647
web_url	String	Pipeline link
sha	String	commit id
ref	String	Branch
status	String	Pipeline status. pending: queuing; running: running; success: successful; failed: failed; canceled: canceled; skipped: skipped; and timedout: timed out Enumeration values: pending running success failed canceled skipped timedout

**Table 9** SimpleMergeRequestDetailDto
Parameter	Type	Description
id	Integer	Definition MR ID. Range N/A.
iid	Integer	Definition MR IID. Range N/A.
title	String	Definition Title. Range N/A.
description	String	Definition Description. Range N/A.
source_branch	String	Definition Source branch. Range N/A.
target_branch	String	Definition Target branch. Range N/A.
state	String	Definition Status. Range N/A.
created_at	String	Definition Creation time. Range N/A.
review_mode	String	Definition Approval mode. Range N/A.
author	UserBasicDto object	User information
merge_request_type	String	Definition MR type. Range N/A.
moderation_result	Boolean	Definition Approving result. Range true: successful. false: failed
moderation_time	Long	Definition Timestamp of approving submission. Range N/A.
moderation_status	Integer	Definition Approving status code. Range N/A.
is_use_temp_branch	Boolean	Definition Use temporary branch or not. Range true: yes. false: no.

**Table 10** UserBasicDto
Parameter	Type	Description
id	Integer	Definition User ID. Value range: 1~2147483647
name	String	Definition Username.
username	String	Definition Username.
state	String	Definition: User status Value range: active: available account blocked: locked user error: The user is not found Enumeration values: active blocked error
service_license_status	Integer	Service-level permission status. 0: disabled; 1: enabled
avatar_url	String	User profile picture URL
avatar_path	String	User profile picture path
email	String	User email
name_cn	String	Username (CN)
web_url	String	User homepage
nick_name	String	User alias
tenant_name	String	Tenant name
error_message	String	Definition When some query APIs detect that the user permission in the transfer parameter is insufficient or the user does not exist, the user is returned but the field is not empty for information.

**Table 11** SimpleDiffDto
Parameter	Type	Description
added_line	Integer	Definition Number of added lines. Range N/A.
deleted_line	Integer	Definition Number of deleted lines. Range N/A.
path	String	Definition Path. Range N/A.

Status code: 401

**Table 12** Response body parameters
Parameter	Type	Description
error_code	String	Definition Error code.
error_msg	String	Definition Error message.

Example Requests

POST https://{endpoint}/v4/repositories/1/repository/commits

{
  "branch" : "master",
  "commit_message" : "message",
  "actions" : [ {
    "action" : "update",
    "file_path" : "README.md",
    "previous_path" : "README.md",
    "content" : "content",
    "encoding" : "text",
    "execute_filemode" : false
  } ],
  "start_branch" : "dev25"
}

Example Responses

Status code: 201

{
  "id" : "d9586a73454ecceb12a53800c293174d601bd4e1",
  "message" : "1234test",
  "parent_ids" : [ "ce25367f2d97093130bc7822ef48d1bb5bd18d86" ],
  "authored_date" : "2025-01-22T02:56:21.000Z",
  "author_name" : "example",
  "author_email" : "example@example.com",
  "committed_date" : "2025-01-22T02:56:21.000Z",
  "committer_name" : "example",
  "committer_email" : "example@example.com",
  "open_gpg_verified" : null,
  "verification_status" : 0,
  "gpg_primary_key_id" : null,
  "name" : null,
  "gpg_nick_name" : null,
  "gpg_tenant_name" : null,
  "gpg_user_name" : null,
  "short_id" : "131ef0cb",
  "created_at" : "2025-01-22T02:56:21.000Z",
  "title" : "1234test",
  "author_avatar_url" : "https://example.com/w3lab/rest/yellowpage/face/30042607/120",
  "committer_avatar_url" : "https://example.com/w3lab/rest/yellowpage/face/30042607/120",
  "relate_url" : null,
  "nick_name" : "test",
  "tenant_name" : "test",
  "user_name" : "test",
  "stats" : {
    "additions" : 0,
    "deletions" : 0,
    "total" : 0
  },
  "status" : null,
  "last_pipeline" : null,
  "project_id" : 2112029050,
  "merge_request" : null,
  "code_changes" : null
}

Status code: 401

Unauthorized

{
  "error_code" : "DEV.00000003",
  "error_msg" : "Authentication information expired."
}

Status Codes

Status Code	Description
201	OK
401	Unauthorized

Error Codes

See Error Codes.

Parent topic: Commit

Previous topic: Obtaining the Change Content of a Specified File Introduced by a Commit

Next topic: Obtaining Specific Commit Information

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.

Which of the following issues have you encountered?

Content is inconsistent with the product UI

Unclear descriptions

Lack of examples or code

Incorrect steps

Can't find what I need

Lack of best practices

Feedback (optional)

0/500

Select at least one type of issue, and enter your comments or suggestions.

Enter a maximum of 500 characters.

Submit Cancel

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

Chatbot