Create Mount
Request Body
Type of mount to create.
Path inside the container where the mount will be attached (e.g.,
/data, /etc/nginx/nginx.conf).ID of the service (application, database, or compose) to attach this mount to.
Type of service this mount is for.
Name of the Docker volume. Required when
type is volume.Absolute path on the host filesystem. Required when
type is bind.Virtual path for the file. Required when
type is file.File content to inject. Required when
type is file.Get Mount
Query Parameters
ID of the mount to retrieve.
Response
Unique identifier for the mount.
Mount type:
volume, bind, or file.Container path where the mount is attached.
Docker volume name (for volume mounts).
Host filesystem path (for bind mounts).
Virtual file path (for file mounts).
File content (for file mounts).
Type of service this mount belongs to.
Application ID (if applicable).
List Mounts by Service
Query Parameters
ID of the service.
Type of service:
application, postgres, mysql, mariadb, mongo, redis, or compose.Response
Returns an array of all mounts configured for the specified service.Update Mount
Request Body
ID of the mount to update.
Updated mount type.
Updated container path.
Updated volume name (for volume mounts).
Updated host path (for bind mounts).
Updated file path (for file mounts).
Updated file content (for file mounts).
Delete Mount
Request Body
ID of the mount to delete.
Mount Types Explained
Volume Mounts
Docker-managed volumes that persist data independently of containers. Use cases:- Database storage
- Application data that needs to persist across deployments
- Shared data between multiple containers
Bind Mounts
Direct mounts from the host filesystem into the container. Use cases:- Development with live code updates
- Sharing configuration files from host
- Accessing host directories for logging
File Mounts
Inject configuration files directly into containers without managing separate config files on the host. Use cases:- Configuration files (nginx.conf, app.json)
- Environment-specific settings
- Small static files
Best Practices
Volume Management
- Use volumes for database storage
- Name volumes descriptively (e.g.,
myapp-postgres-data) - Regularly backup volume data
- Monitor volume disk usage
Bind Mount Security
- Avoid binding sensitive host directories
- Use read-only mounts when possible
- Set appropriate file permissions
- Be cautious with root-owned directories
File Mount Limitations
- Keep file content small (< 1MB recommended)
- For large configurations, use volumes or bind mounts
- File mounts are stored in the database
- Changes require container restart
Path Considerations
- Always use absolute paths for
mountPath - Ensure container processes have appropriate permissions
- Avoid mounting over system directories
- Check for conflicts with existing container files