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 for Network File Storage	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.

Endpoint

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

Authentication

The API uses the following two authentication methods:

• Basic Authentication: Ensure that the string containing your username and password is base64-encoded and separated by a colon: [e-mail]:password.

• Token Authentication: Provide a header value as Bearer followed by your token.

Important: From March 15, 2024, the Basic Authentication option will only be accessible if the 2-factor Authentication (2FA) is disabled for your account.