IONOS Cloud - Network File Storage API (0.1.2)

Download OpenAPI specification:Download

IONOS Cloud Support: support@cloud.ionos.com URL: https://docs.ionos.com/support/general-information/contact-information

The RESTful API for managing Network File Storage.

IONOS Cloud Documentation

Clusters

Operations with clusters

Retrieve Clusters

Retrieve Network File Storage clusters with pagination and optional filters.

Authorizations:

tokenAuth

query Parameters

offset	integer <int32> >= 0 Default: 0 The first element from the total list of elements to include in the response. Use this parameter together with the limit for pagination.
limit	integer <int32> [ 1 .. 1000 ] Default: 100 Example: limit=100 The maximum number of elements to return. Use this parameter together with the offset for pagination.
filter.datacenterId	string <uuid> The datacenter identifier to filter by.

Responses

Response samples

Content type

application/json

{"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": 5
}
}
],
"offset": 0,
"limit": 42,
"_links": {"prev": "http://PREVIOUS-PAGE-URI",
"self": "http://THIS-PAGE-URI",
"next": "http://NEXT-PAGE-URI"
}
}

Create Cluster

Creates a new Network File Storage cluster.

The complete cluster configuration must be provided to create the resource. Optional data will be filled with default values or left empty.

Authorizations:

tokenAuth

Request Body schema: application/json

Cluster to create.

	object Metadata
required	object (Cluster) Network File Storage cluster

Responses

Request samples

Payload

Content type

application/json

{"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": 5
}
}

Response samples

Content type

application/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": 5
}
}

Retrieve Cluster

Returns cluster details by ID.

Authorizations:

tokenAuth

path Parameters

clusterId

required

string <uuid>

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

The identifier (UUID) of the cluster.

Responses

Response samples

Content type

application/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": 5
}
}

Ensure Cluster

Ensures that the cluster with the provided identifier is created or modified. The complete cluster configuration must be provided to update or create the cluster. Any missing data will be filled with default values or left empty, without considering previous values.

Authorizations:

tokenAuth

path Parameters

clusterId

required

string <uuid>

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

The ID (UUID) of the Cluster.

Request Body schema: application/json

Update Cluster

id required	string <uuid> The identifier (UUID) of the cluster.
	object Metadata
required	object (Cluster) Network File Storage cluster

Responses

Request samples

Payload

Content type

application/json

{"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": 5
}
}

Response samples

Content type

application/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": 5
}
}

Delete Cluster

Deletes the specified cluster.

Authorizations:

tokenAuth

path Parameters

clusterId

required

string <uuid>

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

The identifier (UUID) of the cluster.

Responses

Response samples

Content type

application/json

{"httpStatus": 400,
"messages": [{"errorCode": "err-1234",
"message": "Error message example"
}
]
}

Shares

Operations with shares

Retrieve Shares

Retrieves shares of the cluster with pagination and optional filters.

Authorizations:

tokenAuth

path Parameters

clusterId

required

string <uuid>

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

The identifier (UUID) of the cluster.

query Parameters

offset	integer <int32> >= 0 Default: 0 The first element from the total list of elements to include in the response. Use this parameter together with the limit for pagination.
limit	integer <int32> [ 1 .. 1000 ] Default: 100 Example: limit=100 The maximum number of elements to return. Use this parameter together with the offset for pagination.

Responses

Response samples

Content type

application/json

{"id": "ce834630-97f2-56a7-bc99-4427e61d4714",
"type": "collection",
"href": "/clusters/{clusterId}/shares",
"items": [{"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"
}
}
]
}
}
],
"offset": 0,
"limit": 42,
"_links": {"prev": "http://PREVIOUS-PAGE-URI",
"self": "http://THIS-PAGE-URI",
"next": "http://NEXT-PAGE-URI"
}
}

Create Share

Creates a new share.

The complete share configuration must be provided to create the share. Optional data will be filled with default values or left empty.

Authorizations:

tokenAuth

path Parameters

clusterId

required

string <uuid>

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

The identifier (UUID) of the cluster.

Request Body schema: application/json

Share to create.

	object Metadata
required	object (Share) A share represents a directory on a Network File Storage cluster. Options like quotas might be set for this directory.

Responses

Request samples

Payload

Content type

application/json

{"metadata": { },
"properties": {"name": "example-export",
"quota": 512,
"clientGroups": [{"ipNetworks": ["10.234.50.0/24"
],
"hosts": ["10.234.62.123"
],
"nfs": {"squash": "all-anonymous"
}
}
]
}
}

Response samples

Content type

application/json

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

Retrieve Share

Returns the share by ID.

Authorizations:

tokenAuth

path Parameters

clusterId required	string <uuid> Example: e69b22a5-8fee-56b1-b6fb-4a07e4205ead The identifier (UUID) of the cluster.
shareId required	string <uuid> Example: 7b1ef56d-dfc6-51fe-aff0-7af2d6747868 The share identifier.

Responses

Response samples

Content type

application/json

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

Ensure Share

Ensures that the share with the provided ID is created or modified. The complete share configuration must be provided to update or create the share. Any missing data will be filled with default values or left empty, without considering previous values.

Authorizations:

tokenAuth

path Parameters

clusterId required	string <uuid> Example: e69b22a5-8fee-56b1-b6fb-4a07e4205ead The identifier (UUID) of the cluster.
shareId required	string <uuid> Example: 7b1ef56d-dfc6-51fe-aff0-7af2d6747868 The identifier (UUID) of the share.

Request Body schema: application/json

Update Share

id required	string <uuid> The share identifier (UUID).
	object Metadata
required	object (Share) A share represents a directory on a Network File Storage cluster. Options like quotas might be set for this directory.

Responses

Request samples

Payload

Content type

application/json

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

Response samples

Content type

application/json

{"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

Deletes the specified share.

Authorizations:

tokenAuth

path Parameters

clusterId required	string <uuid> Example: e69b22a5-8fee-56b1-b6fb-4a07e4205ead The identifier (UUID) of the cluster.
shareId required	string <uuid> Example: 7b1ef56d-dfc6-51fe-aff0-7af2d6747868 The identifier (UUID) of the share.

Responses

Response samples

Content type

application/json

{"httpStatus": 400,
"messages": [{"errorCode": "err-1234",
"message": "Error message example"
}
]
}