To create a share within the Network File Storage's cluster, via the API, perform a POST request with the clusterId
. The request automatically creates a share within the respective cluster.
Prerequisites:
Only contract administrators, owners, and users with accessAndManageNFS privileges can create and manage clusters.
Use the regional endpoints to create a share:
https://nfs.de-txl.ionos.com/clusters/{clusterId}/shares
https://nfs.de-fra.ionos.com/clusters/{clusterId}/shares
Note: The following request contains sample values. Remember to replace them with the relevant information.
To make authenticated requests to the API, the following fields are mandatory in the request header:
Below is the list of mandatory path parameter:
A 201 message confirms that the share creation is successful. Your values will differ from those in the sample code. It may contain different IDs, timestamps etc.
Header Parameters | Required | Type | Description |
---|---|---|---|
Body Parameters | Type | Description | Example |
---|---|---|---|
Authorization
yes
string
You can use Basic Authentication
or a Bearer token
. For more information, see Authentication.
Content-Type
yes
string
Set this to application/json
.
clusterId
string
The ID (UUID) of the Cluster.
e69b22a5-8fee-56b1-b6fb-4a07e4205ead