Skip to main content
GET
/
v1
/
volumes
/
{id}
/
files
List files or directories in a volume path
import requests

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

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, 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

Volume ID

Query Parameters

​
path
string

Absolute volume-internal path rooted at /. Defaults to / when omitted.

​
depth
integer<uint32>

Optional directory listing depth. Phase 3 currently supports only 1.

Response

Directory listing

​
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