Skip to main content
GET
List Files
path is a directory path rooted at the device’s shared storage — / is the storage root (primary external storage on Android devices), e.g. /Download. The response contains the directory’s direct entries only — it does not recurse into subdirectories. File access is available on Android devices only; file requests against an iOS device fail with 400.
Depending on the device type, some entry metadata (owner, group, permissions, hardLinks) may be zeroed rather than reflect real values.

Authorizations

Authorization
string
header
required

Service Account Token authentication. To authenticate API requests:

  1. Create a Service Account Token:

    • Go to the Cerebrium Dashboard and open the API Keys page
    • Click Create Service Account, name it (e.g., "GitHub Actions CI/CD"), choose an expiry date, and click Create
    • Copy the token generated for the desired service account
  2. Use the Token: Include the service account token in the Authorization header of API requests: Authorization: Bearer <your-service-account-token>

  3. Best Practices:

    • Create separate service accounts for different environments (dev, staging, prod)
    • Store tokens securely as secrets in consuming applications or workflows
    • Set appropriate expiry dates and rotate tokens regularly
    • Never commit tokens to source control

For CI/CD integration examples, see the CI/CD documentation.

Path Parameters

project_id
string
required
volume_id
string
required

Query Parameters

dir
string

Directory path to list. Defaults to the volume root.

region
string

Region of the volume. Default: us-east-1.

Response

Files and folders at the requested path in the volume.

is_folder
boolean

Whether the entry is a folder.

last_modified
string

Timestamp when the file was last modified. Omitted when not available.

name
string

Name of the file or folder.

size_bytes
integer

Size of the file in bytes. Omitted for folders.