Deleting a File

This API is used to delete a file.

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

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. 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

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

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.

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

Status code: 204

{
  "status" : "success"
}

Status code: 401

Unauthorized

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

Status Code	Description
204	OK
401	Unauthorized

Parent topic: File

Thank you very much for your feedback. We will continue working to improve the documentation.

The system is busy. Please try again later.