Help Center/ CodeArts Repo/ API Reference/ APIs/ V4/ File/ Deleting a File
Updated on 2026-01-27 GMT+08:00
View PDF
Share

Deleting a File

Function

This API is used to delete a file.

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

DELETE https://{hostURL}/v4/repositories/{repository_id}/repository/file

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
Table 2 Query Parameters

Parameter

Mandatory

Type

Description

file_path

Yes

String

Definition

File path.

Range

1–10,000 characters.

author_name

No

String

Definition

Author name.

Value range:

1~10000

branch

Yes

String

Definition

Branch name.

Range

1–2,000 characters.

Value range:

1~2000

commit_message

Yes

String

Definition

Delete description.

Range

1–2,000 characters.

Value range:

1~2000

author_email

No

String

Definition

Author's email address.

Range

1–2,000 characters.

Value range:

1~2000

Request Parameters

Table 3 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

Response Parameters

Status code: 204

Table 4 Response body parameters

Parameter

Type

Description

status

String

Definition:

Status code

  • success: The API request is successful.

  • fail: The API request failed.

Enumeration values:

  • success

  • fail

Status code: 401

Table 5 Response body parameters

Parameter

Type

Description

error_code

String

Definition

Error code.

error_msg

String

Definition

Error message.

Example Requests

DELETE https://{endpoint}/v4/repositories/2112015538/repository/file?file_path=2112016471&branch=master&commit_message=123

Example Responses

Status code: 204

OK

{
  "status" : "success"
}

Status code: 401

Unauthorized

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

Status Codes

Status Code

Description

204

OK

401

Unauthorized

Error Codes

See Error Codes.

Parent topic: File