Renaming a File

This API is used to rename a file.

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

PUT https://{hostURL}/v4/repositories/{repository_id}/repository/rename-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** 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
file_path	Yes	String	Definition: File path Value range: N/A
branch_name	Yes	String	Definition: Branch name Value range: N/A
commit_message	Yes	String	Definition: Commit message Value range: N/A
start_branch	No	String	Definition: Push to other branches based on the branch name Value range: N/A
author_email	No	String	Definition: Author email Value range: N/A
author_name	No	String	Definition: Author name Value range: N/A
previous_path	Yes	String	Definition: Address before renaming Value range: N/A
infer_content	No	Boolean	Definition: Whether to migrate the content (cannot be empty if the content field is also empty) Value range: N/A
content	No	String	Definition: File content (cannot be empty if the infer_content is also empty) Value range: N/A
encoding	No	String	Definition: Encoding format Value range: text. Base64. Default value: text
last_commit_id	No	String	Definition: Last known file commit ID Value range: N/A

Status code: 200

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

None

Status code: 200

Renamed successfully.

{
  "branch" : "master",
  "file_path" : "123"
}

Status code: 401

Unauthorized

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

Status code: 403

Bad Request

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

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.