Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
To create a Network File Storage cluster via the API, perform a POST request with the name and description of the cluster.
Prerequisites: Only contract administrators, owners, and users with accessAndManageNFS privileges can create and manage clusters.
Use a region-specific endpoint to create a cluster: https://nfs.{region}.ionos.com/clusters
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:
Authorization
yes
string
Content-Type
yes
string
Set this to application/json
.
Below is the list of mandatory body parameters:
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
A 201 message confirms that the cluster creation is successful.
Use a Bearer token
. For more information, see .
Prerequisite: You need administrative privileges to create and assign user privileges using the Cloud API.
To set user privileges via the Cloud API to access and manage shares and Network File Storage clusters, follow these steps:
Authenticate to the Cloud API using your API credentials.
Create a user using the POST /cloudapi/v6/um/users
endpoint.
Set the following required parameters for the user: user's name
, email address
, and password
.
Create a group using the POST /cloudapi/v6/um/groups
endpoint.
Set accessAndManageNFS
privilege to true
.
Assign the user to the created group using POST /cloudapi/v6/um/groups/{groupId}/users
endpoint.
Note: Remember to provide the user ID in the request body: id: <userID>
Result: The user has the privilege to access and manage Network File Storage.
You can retrieve the information about a specific cluster using its clusterId
.
Use a region-specific endpoint to retrieve a specific cluster: https://nfs.{region}.ionos.com/clusters/{clusterId}
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:
Authorization
yes
string
Content-Type
yes
string
Set this to application/json
.
Below is the list of mandatory path parameter:
clusterId
string
The ID (UUID) of the Cluster.
e69b22a5-8fee-56b1-b6fb-4a07e4205ead
A 200 message confirms that the specific cluster information is successfully retrieved.
You can append a cluster, or update the content of an existing cluster within your Network File Storage using the PUT
API request.
Use a region-specific endpoint to update a cluster: https://nfs.{region}.ionos.com/clusters/{clusterId}
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:
Authorization
yes
string
Content-Type
yes
string
Set this to application/json
.
A 200 message confirms that the specified cluster is successfully updated.
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.
Learn how to set user privileges for Network File Storage via the API.
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.
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
Note: Network File Storage will soon be available in the Worcester, United Kingdom, region.
The API uses the Token Authentication method. Ensure that you specify the header value as Bearer
followed by your token
.
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.
Prerequisites: Only contract administrators, owners, and users with accessAndManageNFS privileges can create and manage clusters.
Use a to create a share: https://nfs.{region}.ionos.com/clusters/{clusterId}/shares
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:
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.
You can delete a specific cluster using its clusterId
.
Use a to delete a cluster: https://nfs.{region}.ionos.com/clusters/{clusterId}
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:
A 202 message confirms that the specified cluster has been successfully deleted.
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.
Use a to retrieve all clusters: https://nfs.{region}.ionos.com/clusters
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:
A 200 message confirms that a list of clusters is fetched.
Use a Bearer token
. For more information, see .
Use a Bearer token
. For more information, see .
Authorization
yes
string
Use a Bearer token
. For more information, see Authentication.
Content-Type
yes
string
Set this to application/json
.
clusterId
string
The ID (UUID) of the Cluster.
e69b22a5-8fee-56b1-b6fb-4a07e4205ead
Authorization
yes
string
Use a Bearer token
. For more information, see Authentication.
Content-Type
yes
string
Set this to application/json
.
clusterId
string
The ID (UUID) of the Cluster.
e69b22a5-8fee-56b1-b6fb-4a07e4205ead
Authorization
yes
string
Use a Bearer token
. For more information, see Authentication.
Content-Type
yes
string
Set this to application/json
.
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.
Use a region-specific endpoint to retrieve all shares: https://nfs.{region}.ionos.com/clusters/{clusterId}/shares
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:
Authorization
yes
string
Content-Type
yes
string
Set this to application/json
.
Below is the list of mandatory path parameter:
clusterId
string
The ID (UUID) of the Cluster.
e69b22a5-8fee-56b1-b6fb-4a07e4205ead
A 200 message confirms that all shares from within the specific cluster are successfully retrieved.
You can delete a specific share from within a cluster using its clusterId
and shareId
.
Use a region-specific endpoint to delete a specific share: https://nfs.{region}.ionos.com/clusters/{clusterId}/shares/{shareId}
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:
Authorization
yes
string
Use a Bearer token
. For more information, see .
Content-Type
yes
string
Set this to application/json
.
Below is the list of mandatory path parameters:
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
A 202 message confirms that the specified share has been successfully deleted.
Use a Bearer token
. For more information, see .
You can append or update the content of an existing share within your Network File Storage using the PUT
API request.
Use a region-specific endpoint to update a share: https://nfs.{region}.ionos.com/clusters/{clusterId}/shares/{shareId}
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:
Authorization
yes
string
Content-Type
yes
string
Set this to application/json
.
A 200 message confirms that the corresponding share within the specified cluster has been successfully updated.
Use a Bearer token
. For more information, see .
You can retrieve the information about a specific share using its clusterId
and shareId
.
Use a region-specific endpoint to retrieve a specific share: https://nfs.{region}.ionos.com/clusters/{clusterId}/shares/{shareId}
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:
Authorization
yes
string
Content-Type
yes
string
Set this to application/json
.
Below is the list of mandatory path parameters:
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
A 200 message confirms that the information of the specific share from within the cluster has been successfully retrieved.
Use a Bearer token
. For more information, see .