Create Share

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.

Important: The user privilege for accessing and managing Network File Storage is not effective yet. Any user with an active token will be granted access to the service management independent of the privilege setting. The group privilege will be added to the application with an upcoming release and the documentation will be updated accordingly.

Endpoint

Use the regional endpoints to create a share:

• Berlin, Germany: https://nfs.de-txl.ionos.com/clusters/{clusterId}/shares

• Frankfurt, Germany: https://nfs.de-fra.ionos.com/clusters/{clusterId}/shares

• Paris, France: https://nfs.fr-par.ionos.com/clusters/{clusterId}/shares

• London, Great Britain: https://nfs.gb-lhr.ionos.com/clusters/{clusterId}/shares

• Logroño, Spain: https://nfs.es-vit.ionos.com/clusters/{clusterId}/shares

• Las Vegas, United States: https://nfs.us-las.ionos.com/clusters/{clusterId}/shares

• Newark, United States: https://nfs.us-ewr.ionos.com/clusters/{clusterId}/shares

• Lenexa, United States: https://nfs.us-mci.ionos.com/clusters/{clusterId}/shares

The region 'Worcester, GB' will follow shortly.

Request

Note: The following request contains sample values. Remember to replace them with the relevant information.

curl -X 'POST' \
  'https://nfs.de-txl.ionos.com/clusters/e69b22a5-8fee-56b1-b6fb-4a07e4205ead/shares' \
  -H 'accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
  "metadata": {},
  "properties": {
    "name": "example-export",
    "quota": 512,
    "clientGroups": [
      {
        "ipNetworks": [
          "10.234.50.0/24"
        ],
        "hosts": [
          "10.234.62.123"
        ],
        "nfs": {
          "squash": "all-anonymous"
        }
      }
    ]
  }
}'

Request Header Parameters

To make authenticated requests to the API, the following fields are mandatory in the request header:

Header Parameters	Required	Type	Description
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.

Request Path Parameters

Below is the list of mandatory path parameter:

Body Parameters	Type	Description	Example
clusterId	string	The ID (UUID) of the Cluster.	e69b22a5-8fee-56b1-b6fb-4a07e4205ead

Response

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.

{
  "id": "7b1ef56d-dfc6-51fe-aff0-7af2d6747868",
  "type": "share",
  "href": "/clusters/{clusterId}/shares/7b1ef56d-dfc6-51fe-aff0-7af2d6747868",
  "metadata": {
    "createdDate": "2020-12-10T13:37:50+01:00",
    "createdBy": "ionos:identity:::users/87f9a82e-b28d-49ed-9d04-fba2c0459cd3",
    "createdByUserId": "87f9a82e-b28d-49ed-9d04-fba2c0459cd3",
    "lastModifiedDate": "2020-12-11T13:37:50+01:00",
    "lastModifiedBy": "ionos:identity:::users/87f9a82e-b28d-49ed-9d04-fba2c0459cd3",
    "lastModifiedByUserId": "87f9a82e-b28d-49ed-9d04-fba2c0459cd3",
    "resourceURN": "ionos:<product>:<location>:<contract>:<resource-path>",
    "status": "AVAILABLE",
    "statusMessage": null,
    "nfsPath": "/data/example-export"
  },
  "properties": {
    "name": "example-export",
    "quota": 512,
    "clientGroups": [
      {
        "ipNetworks": [
          "10.234.50.0/24"
        ],
        "hosts": [
          "10.234.62.123"
        ],
        "nfs": {
          "squash": "all-anonymous"
        }
      }
    ]
  }
} ```