1 of 11

API How-Tos

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

Quick Links

Learn how to create a cluster for Network File Storage.

Learn how to retrieve a specific cluster.

Learn how to retrieve all clusters of a Network File Storage.

Learn how to update a cluster via the API.

Learn how to delete a cluster via the API.

Learn how to create a share within a cluster.

Learn how to retrieve a specific share.

Learn how to retrieve all shares of a cluster.

Learn how to update a specific share via the API.

Learn how to delete a share from within the cluster via the API.

Endpoint

Use the regional endpoints to interact with Network File Storage:

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

The region 'Worcester, GB' will follow shortly.

Authentication

The API uses the following two authentication methods:

Basic Authentication: Ensure that the string containing your username and password is base64-encoded and separated by a colon: username@domain.tld:password.
Token Authentication: Provide a header value as Bearer followed by your token.

Important: From March 15, 2024, the Basic Authentication option will only be accessible if the 2-factor Authentication (2FA) is disabled for your account.

Create Cluster

To create a Network File Storage cluster via the API, perform a POST request with the name and description of the 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 cluster:

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

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' \
  -H 'accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
  "metadata": {},
  "properties": {
    "name": "Cluster 1",
    "connections": [
      {
        "datacenterId": "123e4567-e89b-12d3-a456-426614174001",
        "lan": "1",
        "ipAddress": "10.254.64.1/24"
      }
    ],
    "nfs": {
      "minVersion": "4.2"
    },
    "size": 8
  }
}'

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

Header Parameters

Required

Type

Description

Authorization

yes

string

Content-Type

yes

string

Set this to application/json.

Below is the list of mandatory body parameters:

Body Parameters

Type

Description

Example

name

string

The human-readable name of your cluster.

NFS cluster

datacenterId

string

The ID of the data center where the NFS cluster is located in.

e69b22a5-8fee-56b1-b6fb-4a07e4205ead

lan

string

The LAN to which the NFS cluster should be connected.

1

ipAddress

string

The IP address and prefix of the NFS cluster. The IP address can be either IPv4 or IPv6. The IP address must include the CIDR notation.

10.254.64.1/24

Response

A 201 message confirms that the cluster creation is successful.

{
  "id": "e69b22a5-8fee-56b1-b6fb-4a07e4205ead",
  "type": "cluster",
  "href": "/clusters/e69b22a5-8fee-56b1-b6fb-4a07e4205ead",
  "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
  },
  "properties": {
    "name": "Cluster 1",
    "connections": [
      {
        "datacenterId": "123e4567-e89b-12d3-a456-426614174001",
        "lan": "1",
        "ipAddress": "10.254.64.1/24"
      }
    ],
    "nfs": {
      "minVersion": "4.2"
    },
    "size": 8
  }
} ```

Retrieve Cluster

You can retrieve the information about a specific cluster using its clusterId.

Endpoint

Use the regional endpoints to retrieve a specific cluster:

Berlin, Germany: https://nfs.de-txl.ionos.com/clusters/{clusterId}
Frankfurt, Germany: https://nfs.de-fra.ionos.com/clusters/{clusterId}
Paris, France: https://nfs.fr-par.ionos.com/clusters/{clusterId}
London, Great Britain: https://nfs.gb-lhr.ionos.com/clusters/{clusterId}
Logroño, Spain: https://nfs.es-vit.ionos.com/clusters/{clusterId}
Las Vegas, United States: https://nfs.us-las.ionos.com/clusters/{clusterId}
Newark, United States: https://nfs.us-ewr.ionos.com/clusters/{clusterId}
Lenexa, United States: https://nfs.us-mci.ionos.com/clusters/{clusterId}

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 'GET' \
  'https://nfs.de-txl.ionos.com/clusters/e69b22a5-8fee-56b1-b6fb-4a07e4205ead' \
  -H 'accept: application/json'

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

Header Parameters

Required

Type

Description

Authorization

yes

string

Content-Type

yes

string

Set this to application/json.

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 200 message confirms that the specific cluster information is successfully retrieved.

{
  "id": "e69b22a5-8fee-56b1-b6fb-4a07e4205ead",
  "type": "cluster",
  "href": "/clusters/e69b22a5-8fee-56b1-b6fb-4a07e4205ead",
  "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
  },
  "properties": {
    "name": "Cluster 1",
    "connections": [
      {
        "datacenterId": "123e4567-e89b-12d3-a456-426614174001",
        "lan": "1",
        "ipAddress": "10.254.64.1/24"
      }
    ],
    "nfs": {
      "minVersion": "4.2"
    },
    "size": 8
  }
} ```

Retrieve Clusters

You can retrieve a list of all Network File Storage clusters in your contract. The number of results displayed on each page depends on the following values:

limit limits the number of response elements.
offset specifies the starting point within the collection of resource results returned from the server.

Additionally, you can also use a response filter (filter.datacenterId) to list only the clusters within the specified data center.

Endpoint

Use the regional endpoints to retrieve all clusters:

Berlin, Germany: https://nfs.de-txl.ionos.com/clusters
Frankfurt, Germany: https://nfs.de-fra.ionos.com/clusters
Paris, France: https://nfs.fr-par.ionos.com/clusters
London, Great Britain: https://nfs.gb-lhr.ionos.com/clusters
Logroño, Spain: https://nfs.es-vit.ionos.com/clusters
Las Vegas, United States: https://nfs.us-las.ionos.com/clusters
Newark, United States: https://nfs.us-ewr.ionos.com/clusters
Lenexa, United States: https://nfs.us-mci.ionos.com/clusters

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 'GET' \
  'https://nfs.de-txl.ionos.com/clusters?offset=0&limit=100' \
  -H 'accept: application/json'

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

Header Parameters

Required

Type

Description

Authorization

yes

string

Content-Type

yes

string

Set this to application/json.

Response

A 200 message confirms that a list of clusters is fetched.

{
  "id": "ed17eb1f-ac43-5670-9e63-8be33c475449",
  "type": "collection",
  "href": "/clusters",
  "items": [
    {
      "id": "e69b22a5-8fee-56b1-b6fb-4a07e4205ead",
      "type": "cluster",
      "href": "/clusters/e69b22a5-8fee-56b1-b6fb-4a07e4205ead",
      "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
      },
      "properties": {
        "name": "Cluster 1",
        "connections": [
          {
            "datacenterId": "123e4567-e89b-12d3-a456-426614174001",
            "lan": "1",
            "ipAddress": "10.254.64.1/24"
          }
        ],
        "nfs": {
          "minVersion": "4.2"
        },
        "size": 8
      }
    }
  ],
  "offset": 0,
  "limit": 42,
  "_links": {
    "prev": "http://PREVIOUS-PAGE-URI",
    "self": "http://THIS-PAGE-URI",
    "next": "http://NEXT-PAGE-URI"
  }
} ```

Update Cluster

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

Endpoint

Use the regional endpoints to update a cluster:

Berlin, Germany: https://nfs.de-txl.ionos.com/clusters/{clusterId}
Frankfurt, Germany: https://nfs.de-fra.ionos.com/clusters/{clusterId}
Paris, France: https://nfs.fr-par.ionos.com/clusters/{clusterId}
London, Great Britain: https://nfs.gb-lhr.ionos.com/clusters/{clusterId}
Logroño, Spain: https://nfs.es-vit.ionos.com/clusters/{clusterId}
Las Vegas, United States: https://nfs.us-las.ionos.com/clusters/{clusterId}
Newark, United States: https://nfs.us-ewr.ionos.com/clusters/{clusterId}
Lenexa, United States: https://nfs.us-mci.ionos.com/clusters/{clusterId}

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-fra.ionos.com/clusters/e69b22a5-8fee-56b1-b6fb-4a07e4205ead' \
  -H 'accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
  "id": "e69b22a5-8fee-56b1-b6fb-4a07e4205ead",
  "metadata": {},
  "properties": {
    "name": "Cluster 1",
    "connections": [
      {
        "datacenterId": "123e4567-e89b-12d3-a456-426614174001",
        "lan": "1",
        "ipAddress": "10.254.64.1/24"
      }
    ],
    "nfs": {
      "minVersion": "4.2"
    },
    "size": 8
  }
}'

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

Header Parameters

Required

Type

Description

Authorization

yes

string

Content-Type

yes

string

Set this to application/json.

Response

A 200 message confirms that the specified cluster is successfully updated.

{
 {
  "id": "ed17eb1f-ac43-5670-9e63-8be33c475449",
  "type": "collection",
  "href": "/clusters",
  "items": [
    {
      "id": "e69b22a5-8fee-56b1-b6fb-4a07e4205ead",
      "type": "cluster",
      "href": "/clusters/e69b22a5-8fee-56b1-b6fb-4a07e4205ead",
      "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
      },
      "properties": {
        "name": "Cluster 1",
        "connections": [
          {
            "datacenterId": "123e4567-e89b-12d3-a456-426614174001",
            "lan": "1",
            "ipAddress": "10.254.64.1/24"
          }
        ],
        "nfs": {
          "minVersion": "4.2"
        },
        "size": 8
      }
    }
  ],
  "offset": 0,
  "limit": 42,
  "_links": {
    "prev": "http://PREVIOUS-PAGE-URI",
    "self": "http://THIS-PAGE-URI",
    "next": "http://NEXT-PAGE-URI"
  }
}
} ```

Delete Cluster

You can delete a specific cluster using its clusterId.

Prerequisite: Only contract administrators, owners, and users with accessAndManageNFS privilege can delete clusters via the API.

Endpoint

Use the regional endpoints to delete a cluster:

Berlin, Germany: https://nfs.de-txl.ionos.com/clusters/{clusterId}
Frankfurt, Germany: https://nfs.de-fra.ionos.com/clusters/{clusterId}
Paris, France: https://nfs.fr-par.ionos.com/clusters/{clusterId}
London, Great Britain: https://nfs.gb-lhr.ionos.com/clusters/{clusterId}
Logroño, Spain: https://nfs.es-vit.ionos.com/clusters/{clusterId}
Las Vegas, United States: https://nfs.us-las.ionos.com/clusters/{clusterId}
Newark, United States: https://nfs.us-ewr.ionos.com/clusters/{clusterId}
Lenexa, United States: https://nfs.us-mci.ionos.com/clusters/{clusterId}

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 'DELETE' \
  'https://nfs.de-txl.ionos.com/clusters/e69b22a5-8fee-56b1-b6fb-4a07e4205ead' \
  -H 'accept: application/json'
  -H 'Authorization: Basic <auth-token>'

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

Header Parameters

Required

Type

Description

Authorization

yes

string

Content-Type

yes

string

Set this to application/json.

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 202 message confirms that the specified cluster has been successfully deleted.

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.

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.

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

Below is the list of mandatory path parameter:

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.

Retrieve Share

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

Endpoint

Use the regional endpoints to retrieve a specific 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.

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

Below is the list of mandatory path parameters:

Response

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

Retrieve Shares

You can retrieve the list of all shares from within a cluster using its clusterId. The number of results displayed on each page depends on the following values:

limit limits the number of response elements.
offset specifies the starting point within the collection of resource results returned from the server.

Endpoint

Use the regional endpoints to retrieve all shares:

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.

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

Below is the list of mandatory path parameter:

Response

A 200 message confirms that all shares from within the specific cluster are successfully retrieved.

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

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

Delete Share

You can delete a specific share from within a cluster using its clusterId and shareId.

Endpoint

Use the regional endpoints to delete a specific 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 'DELETE' \
  'https://nfs.de-fra.ionos.com/clusters/e69b22a5-8fee-56b1-b6fb-4a07e4205ead/shares/7b1ef56d-dfc6-51fe-aff0-7af2d6747868' \
  -H 'accept: application/json'

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

Header Parameters

Required

Type

Description

Authorization

yes

string

Content-Type

yes

string

Set this to application/json.

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 202 message confirms that the specified share has been successfully deleted.