Help Center/ CodeArts Repo/ API Reference/ APIs/ V4/ File/ Creating a File
Updated on 2026-04-28 GMT+08:00
View PDF

Creating a File

Function

This API is used to create a file.

Debugging

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

URI

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

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.

Value range:

1~2147483647

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

name

No

String

Username

file_path

Yes

String

File path

branch

Yes

String

Branch name

commit_message

Yes

String

Commit message

author_email

No

String

Author email

author_name

No

String

Author name

content

Yes

String

File content

encoding

No

String

Encoding format

Response Parameters

Status code: 201

Table 4 Response body parameters

Parameter

Type

Description

file_path

String

File path

branch

String

Branch name

Status code: 401

Table 5 Response body parameters

Parameter

Type

Description

error_code

String

Definition

Error code.

error_msg

String

Definition

Error message.

Status code: 403

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

Definition

Error code.

error_msg

String

Definition

Error message.

Status code: 404

Table 7 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/100001/repository/files

{
  "branch" : "***",
  "commit_message" : "****",
  "content" : "***",
  "file_path" : "****"
}

Example Responses

Status code: 201

OK

{
  "file_path" : "11123s4",
  "branch" : "master"
}

Status code: 401

Unauthorized

{
  "error_code" : "CH.00000001",
  "error_msg" : "User authentication info not found."
}

Status code: 403

Bad Request

{
  "error_code" : "CH.00401008",
  "error_msg" : "Insufficient permissions. Apply for the required permissions and try again."
}

Status code: 404

Not Found

{
  "error_code" : "CH.00402000",
  "error_msg" : "The repository does not exist. Check and try again."
}

Status Codes

Status Code

Description

201

OK

401

Unauthorized

403

Bad Request

404

Not Found

Error Codes

See Error Codes.

Parent topic: File