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'

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.

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