Mount & Unmount a Volume - Documentation

Volumes provide persistent storage that you can attach to a sandbox at a mount path. You can mount volumes when creating the sandbox, or mount and unmount them at runtime on a running sandbox.

Mount at creation

Pass volumeMounts (JS) / volume_mounts (Python) to novita.sandbox.create — a mapping from mount path inside the sandbox to a Volume instance or a volume name.

import { Novita } from 'novita-sandbox'

const novita = new Novita()
const volume = await novita.volume.connect('vol_123')

const sandbox = await novita.sandbox.create({
  volumeMounts: {
    '/mnt/data': volume,   // a Volume instance
    '/mnt/shared': 'my-volume-name', // or a volume name
  },
})
console.log('Sandbox created:', sandbox.sandboxId)

from novita_sandbox import Novita

novita = Novita()
volume = novita.volume.connect("vol_123")

sandbox = novita.sandbox.create(
    volume_mounts={
        "/mnt/data": volume,          # a Volume instance
        "/mnt/shared": "my-volume-name",  # or a volume name
    },
)
print("Sandbox created:", sandbox.sandbox_id)

Mount at runtime

sandbox.mountVolume(name, path) / sandbox.mount_volume(name, path) attaches a volume by name to a mount path on a running sandbox and returns the updated sandbox information.

await sandbox.mountVolume('my-volume-name', '/mnt/data')

sandbox.mount_volume("my-volume-name", "/mnt/data")

novita volume mount <sandbox_id> --name <volume_name> --path /mnt/data

Unmount

sandbox.unmountVolume(path) / sandbox.unmount_volume(path) detaches the volume mounted at the given path. Pass force to force the unmount.

await sandbox.unmountVolume('/mnt/data')

// Force unmount
await sandbox.unmountVolume('/mnt/data', { force: true })

sandbox.unmount_volume("/mnt/data")

# Force unmount
sandbox.unmount_volume("/mnt/data", force=True)

novita volume unmount <sandbox_id> --path /mnt/data

# Force unmount
novita volume unmount <sandbox_id> --path /mnt/data --force

Last modified on September 4, 2026