> For the complete documentation index, see [llms.txt](https://docs.ionos.com/cloud/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.ionos.com/cloud/backup-and-storage/network-file-storage/api-how-tos.md).

# API How-Tos

Learn how to create, manage, and delete Network File Storage (NFS) clusters and shares through the Cloud API. Covers regional endpoints on IONOS CLOUD

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

## Quick links

<table data-view="cards"><thead><tr><th></th><th></th><th data-hidden data-card-target data-type="content-ref"></th></tr></thead><tbody><tr><td><mark style="color:blue;"><strong>Set User Privileges through the API</strong></mark></td><td>Create a user and group, then grant the required privilege to manage NFS resources.</td><td><a href="/cloud/backup-and-storage/network-file-storage/api-how-tos/set-user-privileges-api.md">Set User Privileges via the API</a></td></tr><tr><td><mark style="color:blue;"><strong>Create Cluster</strong></mark></td><td>Create an NFS cluster by specifying a name and description.</td><td><a href="/cloud/backup-and-storage/network-file-storage/api-how-tos/create-cluster.md">Create Cluster</a></td></tr><tr><td><mark style="color:blue;"><strong>Retrieve Cluster</strong></mark></td><td>Retrieve a specific NFS cluster's properties and status.</td><td><a href="/cloud/backup-and-storage/network-file-storage/api-how-tos/retrieve-cluster.md">Retrieve Cluster</a></td></tr><tr><td><mark style="color:blue;"><strong>Retrieve Clusters</strong></mark></td><td>Retrieve all NFS clusters in your contract.</td><td><a href="/cloud/backup-and-storage/network-file-storage/api-how-tos/retrieve-clusters.md">Retrieve Clusters</a></td></tr><tr><td><mark style="color:blue;"><strong>Update Cluster</strong></mark></td><td>Update properties, such as name or size, for an existing NFS cluster.</td><td><a href="/cloud/backup-and-storage/network-file-storage/api-how-tos/update-cluster.md">Update Cluster</a></td></tr><tr><td><mark style="color:blue;"><strong>Delete Cluster</strong></mark></td><td>Delete an existing NFS cluster.</td><td><a href="/cloud/backup-and-storage/network-file-storage/api-how-tos/delete-cluster.md">Delete Cluster</a></td></tr><tr><td><mark style="color:blue;"><strong>Create Share</strong></mark></td><td>Create a share within an NFS cluster.</td><td><a href="/cloud/backup-and-storage/network-file-storage/api-how-tos/create-share.md">Create Share</a></td></tr><tr><td><mark style="color:blue;"><strong>Retrieve Share</strong></mark></td><td>Retrieve a specific share's properties and client groups.</td><td><a href="/cloud/backup-and-storage/network-file-storage/api-how-tos/retrieve-share.md">Retrieve Share</a></td></tr><tr><td><mark style="color:blue;"><strong>Retrieve Shares</strong></mark></td><td>Retrieve all shares within an NFS cluster.</td><td><a href="/cloud/backup-and-storage/network-file-storage/api-how-tos/retrieve-shares.md">Retrieve Shares</a></td></tr><tr><td><mark style="color:blue;"><strong>Update Share</strong></mark></td><td>Update properties, such as quota or client groups, for an existing share.</td><td><a href="/cloud/backup-and-storage/network-file-storage/api-how-tos/update-share.md">Update Share</a></td></tr><tr><td><mark style="color:blue;"><strong>Delete Share</strong></mark></td><td>Delete an existing share.</td><td><a href="/cloud/backup-and-storage/network-file-storage/api-how-tos/delete-share.md">Delete Share</a></td></tr></tbody></table>

## Regional endpoints

Use the regional endpoints to interact with NFS:

* 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`

{% hint style="info" %}
**Note:** NFS will soon be available in the Worcester, United Kingdom, region.
{% endhint %}

## API authentication

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


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.ionos.com/cloud/backup-and-storage/network-file-storage/api-how-tos.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.