API How-Tos

Network File Storage APIs allow contract owners, administrators, and authenticated users with the required permissions to create clusters and shares within the storage system via the API.

Quick Links

Set User Privileges via the API

Learn how to set user privileges for Network File Storage via the API.

Create Cluster

Learn how to create a cluster for Network File Storage.

Retrieve Cluster

Learn how to retrieve a specific cluster.

Retrieve Clusters

Learn how to retrieve all clusters of a Network File Storage.

Update Cluster

Learn how to update a cluster via the API.

Delete Cluster

Learn how to delete a cluster via the API.

Create Share

Learn how to create a share within a cluster.

Retrieve Share

Learn how to retrieve a specific share.

Retrieve Shares

Learn how to retrieve all shares of a cluster.

Update Share

Learn how to update a specific share via the API.

Delete Share

Learn how to delete a share from within the cluster via the API.

Endpoints

Use the regional endpoints to interact with Network File Storage:

• Berlin, Germany: https://nfs.de-txl.ionos.com

• Frankfurt, Germany: https://nfs.de-fra.ionos.com

• Paris, France: https://nfs.fr-par.ionos.com

• London, Great Britain: https://nfs.gb-lhr.ionos.com

• Logroño, Spain: https://nfs.es-vit.ionos.com

• Las Vegas, United States: https://nfs.us-las.ionos.com

• Newark, United States: https://nfs.us-ewr.ionos.com

• Lenexa, United States: https://nfs.us-mci.ionos.com

Note: Network File Storage will soon be available in the Worcester, United Kingdom, region.

Authentication

The API uses the Token Authentication method. Ensure that you specify the header value as Bearer followed by your token.