Enterprise File Storage - Managing volume ACLs
Manage Enterprise File Storage volume ACLs using the OVHcloud API
Objective
In this tutorial, we will provide an overview of how to manage ACLs for OVHcloud Enterprise File Storage volumes.
Learn how to list ACLs, create a new ACL and remove an ACL using the OVHcloud API.
Requirements
- An OVHcloud Enterprise File Storage volume
- Access to the
Basics
Volume ACLs allow to authorise or restrict access to a volume.
By default, all access to a newly created volume is restricted. An ACL has to be created in order to allow access.
Using ACLs, you can allow an IP or range of IP addresses (CIDR notation) to access a volume.
Instructions
All API routes used for this tutorial are available under the of the API console.
While using the API, all fields marked with an asterisk (*) are required.
Listing existing ACLs
All existing ACLs 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 ACLs by default.
Allowing access to a volume using an ACL
To create a new ACL, use the following route:
Replace serviceName with the ID of your service and shareId with your volume ID.
Choose the accessLevel you want to allow: either ro (read-only) or rw (read and write).
Finally, replace accessTo with the IP address from which you want to authorize connections.
Removing an ACL
Removing an ACL will prevent all further access from the IP adresses specified by it.
To remove an ACL, use the following route:
Replace serviceName with the ID of your service and shareId with your volume ID.
You can get the aclRuleId either from the ACL creation body response or by listing existing ACLs for your volume.
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.