Enterprise File Storage - Managing volume snapshots
Manage Enterprise File Storage volume snapshots using the OVHcloud API
Objective
In this tutorial, we will provide an overview of how to manage snapshots for OVHcloud Enterprise File Storage volumes.
Learn how to list snapshots, create a new snapshot, get information about a snapshot and remove a snapshot using the OVHcloud API.
Requirements
- An OVHcloud Enterprise File Storage offer with an available volume
- Access to the
Basics
A volume snapshot is a point-in-time, read-only copy of a volume.
Snapshots are created from an existing, operational volume.
Snapshots are linked to a volume, they cannot exist without it.
Instructions
All API routes used for this turorial are available under the of the API console.
While using the API, all fields marked with an asterisk (*) are required.
Listing existing snapshots for a volume
All existing snapshots for a volume can be retrieved using the following route:
Replace serviceName with the ID of your service and shareId with your volume ID.
You should have no snapshots by default.
Creating a new snapshot from a volume
To create a new snapshot, use the following route:
Replace serviceName with the ID of your service and shareId with your volume ID.
Both snapshot name and description parameters are optional.
Get information about a snapshot
To get information about a snapshot, use the following route:
Replace serviceName with the ID of your service, shareId with your volume ID and snapshotId with your snapshot ID.
Removing a snapshot
To remove a snapshot, use the following route:
Replace serviceName with the ID of your service, shareId with your volume ID and snapshotId with your snapshot ID.
Go further
For training or technical assistance implementing our solutions, contact your sales representative or visit our Professional Services page to request a quote and have your project analysed by our experts.
Join our community of users.