For AI agents: the complete documentation index is available at https://docs.ovhcloud.com/en/llms.txt, the full documentation bundle is available at https://docs.ovhcloud.com/en/llms-full.txt, and this page is available as Markdown at https://docs.ovhcloud.com/en/guides/storage-and-backup/file-storage/ha-nas/nas-manage-acls.md.

HA-NAS - Managing ACLs via API

View as Markdown

Find out how to manage HA-NAS access using the OVHcloud API

Objective

The OVHcloud HA-NAS service allows you to manage file storage that can be accessed over a network.

This guide explains how to manage the ACL of a HA-NAS partition via the OVHcloud API.

Requirements

Instructions

All API routes in this guide are available in the of the API console.

Info

When using the API, all fields marked with an asterisk (*) are required.

Retrieving information about your service

All your active services can be retrieved by using the following route:

GET/dedicated/nasha
Warning

Access is denied by default unless granted via the ACL. Only IP addresses attached to your OVHcloud services can be added.

Retrieving the ACL of a partition

To retrieve the IP addresses that can access the partition, use the following route:

ParameterRequiredDescription
serviceNameYesThe internal name of your HA-NAS service
partitionNameYesName of the partition

Retrieving all eligible IP addresses

You can verify the IP addresses that are eligible for access via the following API calls:

ParameterRequiredDescription
serviceNameYesThe internal name of your HA-NAS service
partitionNameYesName of the partition

Adding an ACL entry

To create a new ACL entry that will allow you to connect to your partition, use the following route:

ParameterRequiredDescription
serviceNameYesThe internal name of your HA-NAS service
partitionNameYesName of the partition
ipYesThe IP address or range to be granted access
typeYesACL access type for this entry: readonly or readwrite
Info

Use CIDR notation for IP ranges, for example: 192.0.2.0/24.

Removing an ACL entry

To delete an IP address or address range from the ACL, use the following route:

ParameterRequiredDescription
serviceNameYesThe internal name of your HA-NAS service
partitionNameYesName of the partition
ipYesThe IP address or range to be denied access

Go further

Mount your NAS via NFS share

Mount your NAS on Windows Server via CIFS

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.

Was this page helpful?