List Files
Files
List Files
Retrieve a list of files in a specified volume. Intended for internal use - rather use the cerebrium ls command.
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
Service Account Token authentication. To authenticate API requests:
-
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
-
Use the Token: Include the service account token in the Authorization header of API requests:
Authorization: Bearer <your-service-account-token> -
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.
Query Parameters
Directory path to list. Defaults to the volume root.
Region of the volume. Default: us-east-1.
Response
Files and folders at the requested path in the volume.