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.

Endpoints

Use a region-specific endpoint to create a cluster: https://nfs.{region}.ionos.com/clusters

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
  }
}'

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 Body Parameters

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
  }
} ```