Authorizations
Enter your API Key in the format: Bearer <token>. Get it from https://gbox.ai
Path Parameters
Box ID
"c9bdc193-b54b-4ddb-a035-5ac0c598d32d"
Body
Request parameters for renaming a file/directory
Old path in the box. If the path does not start with '/', the file/directory will be renamed relative to the working directory. If the oldPath does not exist, the rename will fail.
"/home/user/documents/output.txt"
New path in the box. If the path does not start with '/', the file/directory will be renamed relative to the working directory. If the newPath already exists, the rename will fail.
"/home/user/documents/new-name.txt"
Working directory. If not provided, the file will be read from the box.config.workingDir
directory.
"/home/user/documents"
Response
Rename file
- File
- Directory
File system file representation
File type indicator
file
Name of the file
"example.txt"
Full path to the file in the box
"/path/to/example.txt"
Size of the file
"10MB"
File metadata
"755"
Last modified time of the file
"2021-01-01T00:00:00Z"