Skip to main content
POST
/
v1
/
sandboxes
/
{id}
/
files
/
rename
Rename or move a file
import requests

url = "https://api.13-215-85-171.sslip.io/v1/sandboxes/{id}/files/rename"

payload = {
    "old_path": "<string>",
    "new_path": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
{
  "name": "<string>",
  "path": "<string>",
  "is_dir": true,
  "size": 123,
  "type": "file",
  "mode": "0644",
  "permissions": "0644",
  "owner": "<string>",
  "group": "<string>",
  "modified_time": "2023-11-07T05:31:56Z",
  "symlink_target": "<string>"
}

Authorizations

​
Authorization
string
header
required

API key passed as Bearer token

Path Parameters

​
id
string
required

Sandbox ID (e.g. sb_a1b2c3d4)

Body

application/json
​
old_path
string
required

Source sandbox path. Relative paths resolve using the same filesystem contract as PathRequest.path.

​
new_path
string
required

Destination sandbox path. Relative paths resolve using the same filesystem contract as PathRequest.path.

​
user
string

Optional sandbox user for relative-path resolution and ownership.

Response

200 - application/json

Renamed file metadata

​
name
string
required
​
path
string
required

Absolute resolved filesystem path. For sandbox routes this is an absolute sandbox path; for volume routes this is an absolute volume-internal path rooted at /.

​
is_dir
boolean
required
​
size
integer<uint64>
required
​
type
string
required

Entry type (e.g. "file", "directory", "symlink")

Example:

"file"

​
mode
string
Example:

"0644"

​
permissions
string
Example:

"0644"

​
owner
string
​
group
string
​
modified_time
string<date-time>
​
symlink_target
string