All URIs are relative to https://api.ionos.com/cloudapi/v5
Method HTTP request Description
backupunitsDelete
object backupunitsDelete(backupunitId, opts)
Delete a Backup Unit
NOTE: Running through the deletion process will delete: - the backup plans inside the Backup Unit. - all backups associated with the Backup Unit. - the backup user and finally also the unit
Examples
Copy 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 .BackupUnitApi (config);
// Delete a Backup Unit
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
object
Authorization
Basic Authentication, Token Authentication
Content-Type : Not defined
backupunitsFindById
backupunitsFindById(backupunitId, opts)
Returns the specified backup Unit
You can retrieve the details of an specific backup unit.
Examples
Copy 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 .BackupUnitApi (config);
// Returns the specified backup Unit
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
Content-Type : Not defined
backupunitsGet
backupunitsGet(opts)
List Backup Units
You can retrieve a complete list of backup Units that you have access to.
Examples
Copy 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 .BackupUnitApi (config);
// List Backup Units
api_instance
.backupunitsGet ({
pretty : true ,
depth : 56 ,
xContractNumber : 56
options: {}
})
.then ((response) => console .log ( response .data))
.catch ((error) => console .log ( error . response .data));
Parameters
Return type
BackupUnits
Authorization
Basic Authentication, Token Authentication
Content-Type : Not defined
backupunitsPatch
backupunitsPatch(backupunitId, backupUnitProperties, opts)
Partially modify a Backup Unit
You can use update a backup Unit properties
Examples
Copy 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 .BackupUnitApi (config);
// Partially modify a Backup Unit
api_instance
.backupunitsPatch ({
backupunitId : backupunitId_example ,
backupUnitProperties : backupUnitProperties_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
Content-Type : application/json
backupunitsPost
backupunitsPost(backupUnit, opts)
Create a Backup Unit
Create a Backup Unit. A Backup Unit is considered a resource like a virtual datacenter, IP Block, snapshot, etc. It shall be shareable via groups inside our User Management Feature
Examples
Copy 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 .BackupUnitApi (config);
// Create a Backup Unit
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
Content-Type : application/json
backupunitsPut
backupunitsPut(backupunitId, backupUnit, opts)
Modify a Backup Unit
You can use update a backup Unit properties
Examples
Copy 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 .BackupUnitApi (config);
// Modify a Backup Unit
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
Content-Type : application/json
backupunitsSsourlGet
backupunitsSsourlGet(backupunitId, opts)
Returns a single signon URL for the specified backup Unit.
Returns a single signon URL for the specified backup Unit.
Examples
Copy 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 .BackupUnitApi (config);
// Returns a single signon URL for the specified backup Unit.
api_instance
.backupunitsSsourlGet ({
backupunitId : backupunitId_example ,
pretty : true ,
xContractNumber : 56 ,
options : {}
})
.then ((response) => console .log ( response .data))
.catch ((error) => console .log ( error . response .data));
Parameters
Return type
BackupUnitSSO
Authorization
Basic Authentication, Token Authentication
Content-Type : Not defined