Snapshots capture a point-in-time state of a File Storage NFS share. Learn how to list, create, and delete snapshots using the OVHcloud API (v1 /cloud routes) to ensure consistency and operational reliability.
Tip: Refer to the OVHcloud API console for exact operations, HTTP methods, and request schemas.
Requirements
- A Public Cloud project with File Storage Service enabled.
- An existing share in the
availablestate. - API credentials with sufficient permissions to manage shares and snapshots.
- Understanding of key API concepts:
serviceName(project ID),regionName,shareId, and optionalsnapshotId.
Instructions
Step 1: Identify your share
List all shares in your target region to find the share ID:
Confirm that the share is in the available state before creating snapshots.
Step 2: List existing snapshots
Retrieve all snapshots for a given share:
Use the response to retrieve snapshot IDs and statuses before deleting or automating operations.
Step 3: Create a snapshot
Create a snapshot with a JSON payload specifying a human-readable name (and optional description):
- Execute the API call in Step 2 until the snapshot reaches
availablestatus. - Snapshot creation time depends on allocated capacity, I/O activity, and platform load.
- Plan snapshots during low I/O periods to ensure consistency.
NOTE: Snapshots are crash-consistent unless your application explicitly pauses writes before they are taken.
Step 4: Retrieve snapshot details (optional)
Retrieve a single snapshot by ID:
Use this for automated checks after backups or to verify snapshot metadata.
Step 5: Delete a snapshot
Free the storage consumed by a snapshot:
WARNING: Deletion is irreversible. Ensure the snapshot is no longer required.
Go further
- File Storage Service – Key Concepts
- File Storage Service – Getting Started
- Preparing an environment for using the OpenStack API
For more information and tutorials, please see our other Public Cloud support guides or explore the guides for other OVHcloud products and services.