1 of 1

VolumesApi

All URIs are relative to https://api.ionos.com/cloudapi/v6

Method

HTTP request

Description

datacentersVolumesCreateSnapshotPost

datacentersVolumesCreateSnapshotPost(datacenterId, volumeId, opts)

Create volume snapshots

Create a snapshot of the specified volume within the data center; this snapshot can later be used to restore this volume.

Examples

const ionoscloud = require('@ionos-cloud/sdk-nodejs');
// setup authorization
const config = new ionoscloud.Configuration({
    username: 'YOUR_USERNAME',
    password: 'YOUR_PASSWORD',
    apiKey: 'YOUR_API_KEY'
});
const api_instance = new ionoscloud.VolumesApi(config);
// Create volume snapshots
api_instance
  .datacentersVolumesCreateSnapshotPost({
    datacenterId: datacenterId_example,
    volumeId: volumeId_example,
    pretty: true,
    depth: 56,
    xContractNumber: 56,
    name: name_example,
    description: description_example,
    secAuthProtection: true,
    licenceType: licenceType_example, 
        options: {}
  })
  .then((response) => console.log(response.data))
  .catch((error) => console.log(error.response.data));

Parameters

Return type

Snapshot

Authorization

Basic Authentication, Token Authentication

HTTP request headers

Content-Type: application/x-www-form-urlencoded
Accept: application/json

datacentersVolumesDelete

datacentersVolumesDelete(datacenterId, volumeId, opts)

Delete volumes

Delete the specified volume within the data center. Use with caution, the volume will be permanently removed!

Examples

const ionoscloud = require('@ionos-cloud/sdk-nodejs');
// setup authorization
const config = new ionoscloud.Configuration({
    username: 'YOUR_USERNAME',
    password: 'YOUR_PASSWORD',
    apiKey: 'YOUR_API_KEY'
});
const api_instance = new ionoscloud.VolumesApi(config);
// Delete volumes
api_instance
  .datacentersVolumesDelete({
    datacenterId: datacenterId_example,
    volumeId: volumeId_example,
    pretty: true,
    depth: 56,
    xContractNumber: 56, 
        options: {}
  })
  .then((response) => console.log(response.data))
  .catch((error) => console.log(error.response.data));

Parameters

Return type

nil (empty response body)

Authorization

Basic Authentication, Token Authentication

HTTP request headers

Content-Type: Not defined
Accept: application/json

datacentersVolumesFindById

datacentersVolumesFindById(datacenterId, volumeId, opts)

Retrieve volumes

Retrieve the properties of the specified volume within the data center.

Examples

const ionoscloud = require('@ionos-cloud/sdk-nodejs');
// setup authorization
const config = new ionoscloud.Configuration({
    username: 'YOUR_USERNAME',
    password: 'YOUR_PASSWORD',
    apiKey: 'YOUR_API_KEY'
});
const api_instance = new ionoscloud.VolumesApi(config);
// Retrieve volumes
api_instance
  .datacentersVolumesFindById({
    datacenterId: datacenterId_example,
    volumeId: volumeId_example,
    pretty: true,
    depth: 56,
    xContractNumber: 56, 
        options: {}
  })
  .then((response) => console.log(response.data))
  .catch((error) => console.log(error.response.data));

Parameters

Return type

Volume

Authorization

Basic Authentication, Token Authentication

HTTP request headers

Content-Type: Not defined
Accept: application/json

datacentersVolumesGet

datacentersVolumesGet(datacenterId, opts)

List volumes

List all the volumes within the data center.

Examples

const ionoscloud = require('@ionos-cloud/sdk-nodejs');
// setup authorization
const config = new ionoscloud.Configuration({
    username: 'YOUR_USERNAME',
    password: 'YOUR_PASSWORD',
    apiKey: 'YOUR_API_KEY'
});
const api_instance = new ionoscloud.VolumesApi(config);
var filterMap = new Map()
filterMap.set("<property_name>", "<property_value>")
// List volumes
api_instance
  .datacentersVolumesGet({
    datacenterId: datacenterId_example,
    pretty: true,
    depth: 56,
    xContractNumber: 56,
    offset: 56,
    limit: 56, 
    orderBy: "<property_name>"
    maxResults: 2,
    filters: filterMap
    options: {}
  })
  .then((response) => console.log(response.data))
  .catch((error) => console.log(error.response.data));

Parameters

Return type

Volumes

Authorization

Basic Authentication, Token Authentication

HTTP request headers

Content-Type: Not defined
Accept: application/json

datacentersVolumesPatch

datacentersVolumesPatch(datacenterId, volumeId, volume, opts)

Partially modify volumes

Update the properties of the specified storage volume within the data center.

Examples

const ionoscloud = require('@ionos-cloud/sdk-nodejs');
// setup authorization
const config = new ionoscloud.Configuration({
    username: 'YOUR_USERNAME',
    password: 'YOUR_PASSWORD',
    apiKey: 'YOUR_API_KEY'
});
const api_instance = new ionoscloud.VolumesApi(config);
// Partially modify volumes
api_instance
  .datacentersVolumesPatch({
    datacenterId: datacenterId_example,
    volumeId: volumeId_example,
    volume: volume_example,
    pretty: true,
    depth: 56,
    xContractNumber: 56, 
        options: {}
  })
  .then((response) => console.log(response.data))
  .catch((error) => console.log(error.response.data));

Parameters

Return type

Volume

Authorization

Basic Authentication, Token Authentication

HTTP request headers

Content-Type: application/json
Accept: application/json

datacentersVolumesPost

datacentersVolumesPost(datacenterId, volume, opts)

Create a Volume

Creates a storage volume within the specified data center. The volume will not be attached! Attaching volumes is described in the Servers section.

Examples

const ionoscloud = require('@ionos-cloud/sdk-nodejs');
// setup authorization
const config = new ionoscloud.Configuration({
    username: 'YOUR_USERNAME',
    password: 'YOUR_PASSWORD',
    apiKey: 'YOUR_API_KEY'
});
const api_instance = new ionoscloud.VolumesApi(config);
// Create a Volume
api_instance
  .datacentersVolumesPost({
    datacenterId: datacenterId_example,
    volume: volume_example,
    pretty: true,
    depth: 56,
    xContractNumber: 56, 
        options: {}
  })
  .then((response) => console.log(response.data))
  .catch((error) => console.log(error.response.data));

Parameters

Return type

Volume

Authorization

Basic Authentication, Token Authentication

HTTP request headers

Content-Type: application/json
Accept: application/json

datacentersVolumesPut

datacentersVolumesPut(datacenterId, volumeId, volume, opts)

Modify a Volume by ID

Modifies the properties of the specified volume within the data center.

Examples

const ionoscloud = require('@ionos-cloud/sdk-nodejs');
// setup authorization
const config = new ionoscloud.Configuration({
    username: 'YOUR_USERNAME',
    password: 'YOUR_PASSWORD',
    apiKey: 'YOUR_API_KEY'
});
const api_instance = new ionoscloud.VolumesApi(config);
// Modify a Volume by ID
api_instance
  .datacentersVolumesPut({
    datacenterId: datacenterId_example,
    volumeId: volumeId_example,
    volume: volume_example,
    pretty: true,
    depth: 56,
    xContractNumber: 56, 
        options: {}
  })
  .then((response) => console.log(response.data))
  .catch((error) => console.log(error.response.data));

Parameters

Return type

Volume

Authorization

Basic Authentication, Token Authentication

HTTP request headers

Content-Type: application/json
Accept: application/json

datacentersVolumesRestoreSnapshotPost

datacentersVolumesRestoreSnapshotPost(datacenterId, volumeId, opts)

Restore volume snapshots

Restore a snapshot for the specified volume within the data center. A snapshot is an image of a volume, which can be used to restore this volume at a later time.

Examples

const ionoscloud = require('@ionos-cloud/sdk-nodejs');
// setup authorization
const config = new ionoscloud.Configuration({
    username: 'YOUR_USERNAME',
    password: 'YOUR_PASSWORD',
    apiKey: 'YOUR_API_KEY'
});
const api_instance = new ionoscloud.VolumesApi(config);
// Restore volume snapshots
api_instance
  .datacentersVolumesRestoreSnapshotPost({
    datacenterId: datacenterId_example,
    volumeId: volumeId_example,
    pretty: true,
    depth: 56,
    xContractNumber: 56,
    snapshotId: snapshotId_example, 
        options: {}
  })
  .then((response) => console.log(response.data))
  .catch((error) => console.log(error.response.data));

Parameters

Return type

nil (empty response body)

Authorization

Basic Authentication, Token Authentication

HTTP request headers

Content-Type: application/x-www-form-urlencoded
Accept: application/json

VolumesApi

All URIs are relative to https://api.ionos.com/cloudapi/v6

Method

HTTP request

Description

datacentersVolumesCreateSnapshotPost

datacentersVolumesCreateSnapshotPost(datacenterId, volumeId, opts)

Create volume snapshots

Create a snapshot of the specified volume within the data center; this snapshot can later be used to restore this volume.

Examples

const ionoscloud = require('@ionos-cloud/sdk-nodejs');
// setup authorization
const config = new ionoscloud.Configuration({
    username: 'YOUR_USERNAME',
    password: 'YOUR_PASSWORD',
    apiKey: 'YOUR_API_KEY'
});
const api_instance = new ionoscloud.VolumesApi(config);
// Create volume snapshots
api_instance
  .datacentersVolumesCreateSnapshotPost({
    datacenterId: datacenterId_example,
    volumeId: volumeId_example,
    pretty: true,
    depth: 56,
    xContractNumber: 56,
    name: name_example,
    description: description_example,
    secAuthProtection: true,
    licenceType: licenceType_example, 
        options: {}
  })
  .then((response) => console.log(response.data))
  .catch((error) => console.log(error.response.data));

Parameters

Name

Type

Description

Notes

Return type

Snapshot

Authorization

Basic Authentication, Token Authentication

HTTP request headers

Content-Type: application/x-www-form-urlencoded
Accept: application/json

datacentersVolumesDelete

datacentersVolumesDelete(datacenterId, volumeId, opts)

Delete volumes

Delete the specified volume within the data center. Use with caution, the volume will be permanently removed!

Examples

const ionoscloud = require('@ionos-cloud/sdk-nodejs');
// setup authorization
const config = new ionoscloud.Configuration({
    username: 'YOUR_USERNAME',
    password: 'YOUR_PASSWORD',
    apiKey: 'YOUR_API_KEY'
});
const api_instance = new ionoscloud.VolumesApi(config);
// Delete volumes
api_instance
  .datacentersVolumesDelete({
    datacenterId: datacenterId_example,
    volumeId: volumeId_example,
    pretty: true,
    depth: 56,
    xContractNumber: 56, 
        options: {}
  })
  .then((response) => console.log(response.data))
  .catch((error) => console.log(error.response.data));

Parameters

Name

Type

Description

Notes

Return type

nil (empty response body)

Authorization

Basic Authentication, Token Authentication

HTTP request headers

Content-Type: Not defined
Accept: application/json

datacentersVolumesFindById

datacentersVolumesFindById(datacenterId, volumeId, opts)

Retrieve volumes

Retrieve the properties of the specified volume within the data center.

Examples

const ionoscloud = require('@ionos-cloud/sdk-nodejs');
// setup authorization
const config = new ionoscloud.Configuration({
    username: 'YOUR_USERNAME',
    password: 'YOUR_PASSWORD',
    apiKey: 'YOUR_API_KEY'
});
const api_instance = new ionoscloud.VolumesApi(config);
// Retrieve volumes
api_instance
  .datacentersVolumesFindById({
    datacenterId: datacenterId_example,
    volumeId: volumeId_example,
    pretty: true,
    depth: 56,
    xContractNumber: 56, 
        options: {}
  })
  .then((response) => console.log(response.data))
  .catch((error) => console.log(error.response.data));

Parameters

Name

Type

Description

Notes

Return type

Volume

Authorization

Basic Authentication, Token Authentication

HTTP request headers

Content-Type: Not defined
Accept: application/json

datacentersVolumesGet

datacentersVolumesGet(datacenterId, opts)

List volumes

List all the volumes within the data center.

Examples

const ionoscloud = require('@ionos-cloud/sdk-nodejs');
// setup authorization
const config = new ionoscloud.Configuration({
    username: 'YOUR_USERNAME',
    password: 'YOUR_PASSWORD',
    apiKey: 'YOUR_API_KEY'
});
const api_instance = new ionoscloud.VolumesApi(config);
var filterMap = new Map()
filterMap.set("<property_name>", "<property_value>")
// List volumes
api_instance
  .datacentersVolumesGet({
    datacenterId: datacenterId_example,
    pretty: true,
    depth: 56,
    xContractNumber: 56,
    offset: 56,
    limit: 56, 
    orderBy: "<property_name>"
    maxResults: 2,
    filters: filterMap
    options: {}
  })
  .then((response) => console.log(response.data))
  .catch((error) => console.log(error.response.data));

Parameters

Name

Type

Description

Notes

Return type

Volumes

Authorization

Basic Authentication, Token Authentication

HTTP request headers

Content-Type: Not defined
Accept: application/json

datacentersVolumesPatch

datacentersVolumesPatch(datacenterId, volumeId, volume, opts)

Partially modify volumes

Update the properties of the specified storage volume within the data center.

Examples

const ionoscloud = require('@ionos-cloud/sdk-nodejs');
// setup authorization
const config = new ionoscloud.Configuration({
    username: 'YOUR_USERNAME',
    password: 'YOUR_PASSWORD',
    apiKey: 'YOUR_API_KEY'
});
const api_instance = new ionoscloud.VolumesApi(config);
// Partially modify volumes
api_instance
  .datacentersVolumesPatch({
    datacenterId: datacenterId_example,
    volumeId: volumeId_example,
    volume: volume_example,
    pretty: true,
    depth: 56,
    xContractNumber: 56, 
        options: {}
  })
  .then((response) => console.log(response.data))
  .catch((error) => console.log(error.response.data));

Parameters

Name

Type

Description

Notes

Return type

Volume

Authorization

Basic Authentication, Token Authentication

HTTP request headers

Content-Type: application/json
Accept: application/json

datacentersVolumesPost

datacentersVolumesPost(datacenterId, volume, opts)

Create a Volume

Creates a storage volume within the specified data center. The volume will not be attached! Attaching volumes is described in the Servers section.

Examples

const ionoscloud = require('@ionos-cloud/sdk-nodejs');
// setup authorization
const config = new ionoscloud.Configuration({
    username: 'YOUR_USERNAME',
    password: 'YOUR_PASSWORD',
    apiKey: 'YOUR_API_KEY'
});
const api_instance = new ionoscloud.VolumesApi(config);
// Create a Volume
api_instance
  .datacentersVolumesPost({
    datacenterId: datacenterId_example,
    volume: volume_example,
    pretty: true,
    depth: 56,
    xContractNumber: 56, 
        options: {}
  })
  .then((response) => console.log(response.data))
  .catch((error) => console.log(error.response.data));

Parameters

Name

Type

Description

Notes

Return type

Volume

Authorization

Basic Authentication, Token Authentication

HTTP request headers

Content-Type: application/json
Accept: application/json

datacentersVolumesPut

datacentersVolumesPut(datacenterId, volumeId, volume, opts)

Modify a Volume by ID

Modifies the properties of the specified volume within the data center.

Examples

const ionoscloud = require('@ionos-cloud/sdk-nodejs');
// setup authorization
const config = new ionoscloud.Configuration({
    username: 'YOUR_USERNAME',
    password: 'YOUR_PASSWORD',
    apiKey: 'YOUR_API_KEY'
});
const api_instance = new ionoscloud.VolumesApi(config);
// Modify a Volume by ID
api_instance
  .datacentersVolumesPut({
    datacenterId: datacenterId_example,
    volumeId: volumeId_example,
    volume: volume_example,
    pretty: true,
    depth: 56,
    xContractNumber: 56, 
        options: {}
  })
  .then((response) => console.log(response.data))
  .catch((error) => console.log(error.response.data));

Parameters

Name

Type

Description

Notes

Return type

Volume

Authorization

Basic Authentication, Token Authentication

HTTP request headers

Content-Type: application/json
Accept: application/json

datacentersVolumesRestoreSnapshotPost

datacentersVolumesRestoreSnapshotPost(datacenterId, volumeId, opts)

Restore volume snapshots

Restore a snapshot for the specified volume within the data center. A snapshot is an image of a volume, which can be used to restore this volume at a later time.

Examples

const ionoscloud = require('@ionos-cloud/sdk-nodejs');
// setup authorization
const config = new ionoscloud.Configuration({
    username: 'YOUR_USERNAME',
    password: 'YOUR_PASSWORD',
    apiKey: 'YOUR_API_KEY'
});
const api_instance = new ionoscloud.VolumesApi(config);
// Restore volume snapshots
api_instance
  .datacentersVolumesRestoreSnapshotPost({
    datacenterId: datacenterId_example,
    volumeId: volumeId_example,
    pretty: true,
    depth: 56,
    xContractNumber: 56,
    snapshotId: snapshotId_example, 
        options: {}
  })
  .then((response) => console.log(response.data))
  .catch((error) => console.log(error.response.data));

Parameters

Name

Type

Description

Notes

Return type

nil (empty response body)

Authorization

Basic Authentication, Token Authentication

HTTP request headers

Content-Type: application/x-www-form-urlencoded
Accept: application/json