Back to Guides
Manage Volumes with the Public API
Here are examples to help you manage persistent volumes using the Public API.
Get project volumes
List all volumes in a project:
Variables
Get volume instance details
Get details about a volume instance (volume in a specific environment):
Variables
Create a volume
Create a new persistent volume attached to a service:
Variables
Update a volume
Rename a volume:
Variables
Update volume instance
Update the mount path for a volume instance:
Variables
Delete a volume
This will permanently delete the volume and all its data.
Variables
Volume backups
List backups
Get all backups for a volume instance:
Variables
Create a backup
Variables
Restore from backup
Variables
Lock a backup (prevent expiration)
Variables
Delete a backup
Variables
Backup schedules
List backup schedules
Variables
Common mount paths
| Use Case | Recommended Mount Path |
|---|---|
| PostgreSQL | /var/lib/postgresql/data |
| MySQL | /var/lib/mysql |
| MongoDB | /data/db |
| Redis | /data |
| General Storage | /data or /app/data |