1 of 1

BackupUnitsApi

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

Method

HTTP request

Description

backupunitsDelete

backupunitsDelete(backupunitId, opts)

Delete backup units

Remove the specified backup unit. This process will delete: 1) The backup plans inside the backup unit 2) All backups, associated with this backup unit 3) The backup user 4) The backup unit itself

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.BackupUnitsApi(config);
// Delete backup units
api_instance
  .backupunitsDelete({
    backupunitId: backupunitId_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

backupunitsFindById

backupunitsFindById(backupunitId, opts)

Retrieve backup units

Retrieve the properties of the specified backup unit.

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.BackupUnitsApi(config);
// Retrieve backup units
api_instance
  .backupunitsFindById({
    backupunitId: backupunitId_example,
    pretty: true,
    depth: 56,
    xContractNumber: 56, 
        options: {}
  })
  .then((response) => console.log(response.data))
  .catch((error) => console.log(error.response.data));

Parameters

Return type

BackupUnit

Authorization

Basic Authentication, Token Authentication

HTTP request headers

Content-Type: Not defined
Accept: application/json

backupunitsGet

backupunitsGet(opts)

List backup units

List all available backup units.

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.BackupUnitsApi(config);
var filterMap = new Map()
filterMap.set("<property_name>", "<property_value>")
// List backup units
api_instance
  .backupunitsGet({
    pretty: true,
    depth: 56,
    xContractNumber: 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

BackupUnits

Authorization

Basic Authentication, Token Authentication

HTTP request headers

Content-Type: Not defined
Accept: application/json

backupunitsPatch

backupunitsPatch(backupunitId, backupUnit, opts)

Partially modify backup units

Update the properties of the specified backup unit.

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.BackupUnitsApi(config);
// Partially modify backup units
api_instance
  .backupunitsPatch({
    backupunitId: backupunitId_example,
    backupUnit: backupUnit_example,
    pretty: true,
    depth: 56,
    xContractNumber: 56, 
        options: {}
  })
  .then((response) => console.log(response.data))
  .catch((error) => console.log(error.response.data));

Parameters

Return type

BackupUnit

Authorization

Basic Authentication, Token Authentication

HTTP request headers

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

backupunitsPost

backupunitsPost(backupUnit, opts)

Create backup units

Create a backup unit. Backup units are resources, same as storage volumes or snapshots; they can be shared through groups in User management.

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.BackupUnitsApi(config);
// Create backup units
api_instance
  .backupunitsPost({
    backupUnit: backupUnit_example,
    pretty: true,
    depth: 56,
    xContractNumber: 56, 
        options: {}
  })
  .then((response) => console.log(response.data))
  .catch((error) => console.log(error.response.data));

Parameters

Return type

BackupUnit

Authorization

Basic Authentication, Token Authentication

HTTP request headers

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

backupunitsPut

backupunitsPut(backupunitId, backupUnit, opts)

Modify backup units

Modify the properties of the specified backup unit.

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.BackupUnitsApi(config);
// Modify backup units
api_instance
  .backupunitsPut({
    backupunitId: backupunitId_example,
    backupUnit: backupUnit_example,
    pretty: true,
    depth: 56,
    xContractNumber: 56, 
        options: {}
  })
  .then((response) => console.log(response.data))
  .catch((error) => console.log(error.response.data));

Parameters

Return type

BackupUnit

Authorization

Basic Authentication, Token Authentication

HTTP request headers

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

backupunitsSsourlGet

backupunitsSsourlGet(backupunitId, opts)

Retrieve BU single sign-on URLs

Retrieve a single sign-on URL for the specified backup unit.

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.BackupUnitsApi(config);
var filterMap = new Map()
filterMap.set("<property_name>", "<property_value>")
// Retrieve BU single sign-on URLs
api_instance
  .backupunitsSsourlGet({
    backupunitId: backupunitId_example,
    pretty: true,
    xContractNumber: 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

BackupUnitSSO

Authorization

Basic Authentication, Token Authentication

HTTP request headers

Content-Type: Not defined
Accept: application/json

BackupUnitsApi

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

Method

HTTP request

Description

backupunitsDelete

backupunitsDelete(backupunitId, opts)

Delete backup units

Remove the specified backup unit. This process will delete: 1) The backup plans inside the backup unit 2) All backups, associated with this backup unit 3) The backup user 4) The backup unit itself

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.BackupUnitsApi(config);
// Delete backup units
api_instance
  .backupunitsDelete({
    backupunitId: backupunitId_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

backupunitsFindById

backupunitsFindById(backupunitId, opts)

Retrieve backup units

Retrieve the properties of the specified backup unit.

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.BackupUnitsApi(config);
// Retrieve backup units
api_instance
  .backupunitsFindById({
    backupunitId: backupunitId_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

BackupUnit

Authorization

Basic Authentication, Token Authentication

HTTP request headers

Content-Type: Not defined
Accept: application/json

backupunitsGet

backupunitsGet(opts)

List backup units

List all available backup units.

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.BackupUnitsApi(config);
var filterMap = new Map()
filterMap.set("<property_name>", "<property_value>")
// List backup units
api_instance
  .backupunitsGet({
    pretty: true,
    depth: 56,
    xContractNumber: 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

BackupUnits

Authorization

Basic Authentication, Token Authentication

HTTP request headers

Content-Type: Not defined
Accept: application/json

backupunitsPatch

backupunitsPatch(backupunitId, backupUnit, opts)

Partially modify backup units

Update the properties of the specified backup unit.

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.BackupUnitsApi(config);
// Partially modify backup units
api_instance
  .backupunitsPatch({
    backupunitId: backupunitId_example,
    backupUnit: backupUnit_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

BackupUnit

Authorization

Basic Authentication, Token Authentication

HTTP request headers

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

backupunitsPost

backupunitsPost(backupUnit, opts)

Create backup units

Create a backup unit. Backup units are resources, same as storage volumes or snapshots; they can be shared through groups in User management.

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.BackupUnitsApi(config);
// Create backup units
api_instance
  .backupunitsPost({
    backupUnit: backupUnit_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

BackupUnit

Authorization

Basic Authentication, Token Authentication

HTTP request headers

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

backupunitsPut

backupunitsPut(backupunitId, backupUnit, opts)

Modify backup units

Modify the properties of the specified backup unit.

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.BackupUnitsApi(config);
// Modify backup units
api_instance
  .backupunitsPut({
    backupunitId: backupunitId_example,
    backupUnit: backupUnit_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

BackupUnit

Authorization

Basic Authentication, Token Authentication

HTTP request headers

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

backupunitsSsourlGet

backupunitsSsourlGet(backupunitId, opts)

Retrieve BU single sign-on URLs

Retrieve a single sign-on URL for the specified backup unit.

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.BackupUnitsApi(config);
var filterMap = new Map()
filterMap.set("<property_name>", "<property_value>")
// Retrieve BU single sign-on URLs
api_instance
  .backupunitsSsourlGet({
    backupunitId: backupunitId_example,
    pretty: true,
    xContractNumber: 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

BackupUnitSSO

Authorization

Basic Authentication, Token Authentication

HTTP request headers

Content-Type: Not defined
Accept: application/json