Retrieve Share

You can retrieve the information about a specific share using its clusterId and shareId.

Endpoints

Use a region-specific endpoint to retrieve a specific share: https://nfs.{region}.ionos.com/clusters/{clusterId}/shares/{shareId}

Request

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

curl -X 'GET' \
  'https://nfs.de-txl.ionos.com/clusters/e69b22a5-8fee-56b1-b6fb-4a07e4205ead/shares/7b1ef56d-dfc6-51fe-aff0-7af2d6747868' \
  -H 'accept: application/json'

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.

Path Parameters

Below is the list of mandatory path parameters:

Body Parameters	Type	Description	Example
clusterId	string	The ID (UUID) of the cluster.	e69b22a5-8fee-56b1-b6fb-4a07e4205ead
shareId	string	The ID (UUID) of the share.	7b1ef56d-dfc6-51fe-aff0-7af2d6747868

Response

A 200 message confirms that the information of the specific share from within the cluster has been successfully retrieved.

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