API docs by Redocly

IONOS Cloud - Network File Storage API (0.1.3)

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

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

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

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

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 identifier (UUID) of the cluster.

Responses

Response samples

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

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

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

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

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

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 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": [
    ]
}