Update Share

You can append or update the content of an existing share within your Network File Storage using the PUT API request.

Endpoint

Use the regional endpoints to update a share:

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

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

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

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

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

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

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

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

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 'PUT' \
  'https://nfs.de-txl.ionos.com/clusters/e69b22a5-8fee-56b1-b6fb-4a07e4205ead/shares/7b1ef56d-dfc6-51fe-aff0-7af2d6747868' \
  -H 'accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
  "id": "7b1ef56d-dfc6-51fe-aff0-7af2d6747868",
  "metadata": {},
  "properties": {
    "name": "example-export",
    "quota": 512,
    "clientGroups": [
      {
        "ipNetworks": [
          "10.234.50.0/24"
        ],
        "hosts": [
          "10.234.62.123"
        ],
        "nfs": {
          "squash": "all-anonymous"
        }
      }
    ]
  }
}'

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.

Response

A 200 message confirms that the corresponding share within the specified cluster has been successfully updated.

{
  "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"
        }
      }
    ]
  }
}

Last updated