Setup
Create a workspace access token, pick a volume and grant the token’s principal access to it, then export the workspace host and token.Create a token and grant volume access
Create a token and grant volume access
- In the workspace, click the username in the top bar, then Settings, Developer, and Manage next to Access tokens.
- Click Generate new token and give it a name and a lifetime. A scoped
token needs the
filesAPI scope. Copy the token: it is shown once. - Pick a volume in Catalog Explorer. Its
/Volumes/<catalog>/<schema>/<volume>/path gives thecatalog,schemaandvolumefields. - Grant the principal
USE CATALOG,USE SCHEMAandREAD VOLUME, plusWRITE VOLUMEfor a write mount. See volume privileges.
DATABRICKS_HOSTis the workspace origin, such ashttps://adb-xxxxxxxxxxxx.xx.azuredatabricks.neton Azure:http://orhttps://, no path, query, fragment or user info. A trailing slash is fine.tokenalso takes a function, sync or async, that returns the current token. The function owns refresh, caching and concurrent refreshes.- Mirage reads no environment variables, SDK profiles or default credentials, and never retries a refused request with another credential.
- Bind each VFS and workspace to one principal and keep caches apart across identities. Rebuild the workspace or drop its caches when the principal or its permissions change; a token refresh for the same principal keeps the VFS.
Connect
- YAML
- Python
- TypeScript
workspace.yaml
Layout
/dbx/reports/2026/q1/summary.mdis/Volumes/main/default/agent_files/reports/2026/q1/summary.md.root_path: /reportsmounts only that folder of the volume;..is refused.- Files keep their own names and bytes; nothing is converted.
Sample runs
write mount, >, cp, mv, rm and mkdir change the volume, as far
as the principal’s WRITE VOLUME grant allows.
SDK guides
Python
Every config field, the VFS.md and write support.
TypeScript
Every config field, the VFS.md and write support.