API docs by Redocly

IONOS Cloud - Network File Storage API (0.1.5)

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

Network File Storage cluster

This tag groups all operations for clusters.

Retrieve all Clusters

This endpoint enables retrieving all Clusters using pagination and optional filters.

Authorizations:
tokenAuth
query Parameters
offset
integer <int32> >= 0
Default: 0

The first element (of 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 ID to filter by.

Responses

Response samples

Content type
application/json
{
  • "id": "ed17eb1f-ac43-5670-9e63-8be33c475449",
  • "type": "collection",
  • "href": "/clusters",
  • "items": [
    ],
  • "offset": 0,
  • "limit": 42,
  • "_links": {}
}

Create Cluster

Creates a new Cluster.

The full Cluster needs to be provided to create the object. Optional data will be filled with defaults 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

Content type
application/json
{
  • "metadata": { },
  • "properties": {
    }
}

Response samples

Content type
application/json
{
  • "id": "e69b22a5-8fee-56b1-b6fb-4a07e4205ead",
  • "type": "cluster",
  • "href": "/clusters/e69b22a5-8fee-56b1-b6fb-4a07e4205ead",
  • "metadata": {
    },
  • "properties": {
    }
}

Retrieve Cluster

Returns the Cluster by ID.

Authorizations:
tokenAuth
path Parameters
clusterId
required
string <uuid>
Example: e69b22a5-8fee-56b1-b6fb-4a07e4205ead

The ID (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": {
    },
  • "properties": {
    }
}

Ensure Cluster

Ensures that the Cluster with the provided ID is created or modified. The full Cluster needs to be provided to ensure (either update or create) the Cluster. Non present data will only be filled with defaults or left empty, but not take previous values into consideration.

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 ID (UUID) of the Cluster.

object

Metadata

required
object (Cluster)

Network File Storage cluster

Responses

Request samples

Content type
application/json
{
  • "id": "e69b22a5-8fee-56b1-b6fb-4a07e4205ead",
  • "metadata": { },
  • "properties": {
    }
}

Response samples

Content type
application/json
{
  • "id": "e69b22a5-8fee-56b1-b6fb-4a07e4205ead",
  • "type": "cluster",
  • "href": "/clusters/e69b22a5-8fee-56b1-b6fb-4a07e4205ead",
  • "metadata": {
    },
  • "properties": {
    }
}

Delete Cluster

Deletes the specified Cluster.

Authorizations:
tokenAuth
path Parameters
clusterId
required
string <uuid>
Example: e69b22a5-8fee-56b1-b6fb-4a07e4205ead

The ID (UUID) of the Cluster.

Responses

Response samples

Content type
application/json
{
  • "httpStatus": 400,
  • "messages": [
    ]
}

Shares

A share represents a directory on a Network File Storage cluster, where options like quotas can be set for the directory.

This tag groups all operations for shares.

Retrieve all Shares

This endpoint enables retrieving all Shares using pagination and optional filters.

Authorizations:
tokenAuth
path Parameters
clusterId
required
string <uuid>
Example: e69b22a5-8fee-56b1-b6fb-4a07e4205ead

The ID (UUID) of the Cluster.

query Parameters
offset
integer <int32> >= 0
Default: 0

The first element (of 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": [
    ],
  • "offset": 0,
  • "limit": 42,
  • "_links": {}
}

Create Share

Creates a new Share.

The full Share needs to be provided to create the object. Optional data will be filled with defaults or left empty.

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

Share to create.

object

Metadata

required
object (Share)

A share represents a directory on a Network File Storage cluster, where options like quotas can be set for the directory.

Responses

Request samples

Content type
application/json
{
  • "metadata": { },
  • "properties": {
    }
}

Response samples

Content type
application/json
{
  • "id": "7b1ef56d-dfc6-51fe-aff0-7af2d6747868",
  • "type": "share",
  • "href": "/clusters/{clusterId}/shares/7b1ef56d-dfc6-51fe-aff0-7af2d6747868",
  • "metadata": {
    },
  • "properties": {
    }
}

Retrieve Share

Returns the Share by ID.

Authorizations:
tokenAuth
path Parameters
clusterId
required
string <uuid>
Example: e69b22a5-8fee-56b1-b6fb-4a07e4205ead

The ID (UUID) of the Cluster.

shareId
required
string <uuid>
Example: 7b1ef56d-dfc6-51fe-aff0-7af2d6747868

The ID (UUID) of the Share.

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": {
    },
  • "properties": {
    }
}

Ensure Share

Ensures that the Share with the provided ID is created or modified. The full Share needs to be provided to ensure (either update or create) the Share. Non present data will only be filled with defaults or left empty, but not take previous values into consideration.

Authorizations:
tokenAuth
path Parameters
clusterId
required
string <uuid>
Example: e69b22a5-8fee-56b1-b6fb-4a07e4205ead

The ID (UUID) of the Cluster.

shareId
required
string <uuid>
Example: 7b1ef56d-dfc6-51fe-aff0-7af2d6747868

The ID (UUID) of the Share.

Request Body schema: application/json

update Share

id
required
string <uuid>

The ID (UUID) of the Share.

object

Metadata

required
object (Share)

A share represents a directory on a Network File Storage cluster, where options like quotas can be set for the directory.

Responses

Request samples

Content type
application/json
{
  • "id": "7b1ef56d-dfc6-51fe-aff0-7af2d6747868",
  • "metadata": { },
  • "properties": {
    }
}

Response samples

Content type
application/json
{
  • "id": "7b1ef56d-dfc6-51fe-aff0-7af2d6747868",
  • "type": "share",
  • "href": "/clusters/{clusterId}/shares/7b1ef56d-dfc6-51fe-aff0-7af2d6747868",
  • "metadata": {
    },
  • "properties": {
    }
}

Delete Share

Deletes the specified Share.

Authorizations:
tokenAuth
path Parameters
clusterId
required
string <uuid>
Example: e69b22a5-8fee-56b1-b6fb-4a07e4205ead

The ID (UUID) of the Cluster.

shareId
required
string <uuid>
Example: 7b1ef56d-dfc6-51fe-aff0-7af2d6747868

The ID (UUID) of the Share.

Responses

Response samples

Content type
application/json
{
  • "httpStatus": 400,
  • "messages": [
    ]
}