# Create Cluster

To create a Network File Storage cluster via the API, perform a POST request with the name and description of the cluster.

{% hint style="info" %}
**Prerequisites:** Only contract administrators, owners, and users with **accessAndManageNFS** privileges can create and manage clusters.
{% endhint %}

## Endpoints

Use a [<mark style="color:blue;">region-specific endpoint</mark>](https://docs.ionos.com/sections-test/guides/storage-and-backup/network-file-storage/api-how-tos/..#endpoints) to create a cluster: `https://nfs.{region}.ionos.com/clusters`

## Request

{% hint style="info" %}
**Note:** The following request contains sample values. Remember to replace them with the relevant information.
{% endhint %}

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

{% tabs %}
{% tab title="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 | Use a `Bearer token`. For more information, see [Authentication](https://docs.ionos.com/sections-test/guides/storage-and-backup/network-file-storage/api-how-tos/..#authentication). |
| `Content-Type`    |    yes   | string | Set this to `application/json`.                                                                                                                                                      |
| {% endtab %}      |          |        |                                                                                                                                                                                      |

{% tab title="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`                       |
| {% endtab %}    |        |                                                                                                                                         |                                        |
| {% endtabs %}   |        |                                                                                                                                         |                                        |

## Response

A **201** message confirms that the cluster creation is successful.

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