BackupUnitApi
All URIs are relative to https://api.ionos.com/cloudapi/v5
Method | HTTP request | Description |
---|---|---|
DELETE /backupunits/{backupunitId} | Delete a Backup Unit | |
GET /backupunits/{backupunitId} | Returns the specified backup Unit | |
GET /backupunits | List Backup Units | |
PATCH /backupunits/{backupunitId} | Partially modify a Backup Unit | |
POST /backupunits | Create a Backup Unit | |
PUT /backupunits/{backupunitId} | Modify a Backup Unit | |
GET /backupunits/{backupunitId}/ssourl | Returns a single signon URL for the specified backup Unit. |
backupunits_delete
Object backupunits_delete(backupunit_id, 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
Using the backupunits_delete_with_http_info variant
This returns an Array which contains the response data, status code and headers.
<Array(Object, Integer, Hash)> backupunits_delete_with_http_info(backupunit_id, opts)
Parameters
Name | Type | Description | Notes |
---|---|---|---|
backupunit_id | String | The unique ID of the backup Unit | |
pretty | Boolean | Controls whether response is pretty-printed (with indentation and new lines) | [optional][default to true] |
depth | Integer | Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on | [optional][default to 0] |
x_contract_number | Integer | Users having more than 1 contract need to provide contract number, against which all API requests should be executed | [optional] |
Return type
Object
Authorization
Basic Authentication, Token Authentication
HTTP request headers
Content-Type: Not defined
Accept: application/json
backupunits_find_by_id
backupunits_find_by_id(backupunit_id, opts)
Returns the specified backup Unit
You can retrieve the details of an specific backup unit.
Examples
Using the backupunits_find_by_id_with_http_info variant
This returns an Array which contains the response data, status code and headers.
<Array(, Integer, Hash)> backupunits_find_by_id_with_http_info(backupunit_id, opts)
Parameters
Name | Type | Description | Notes |
---|---|---|---|
backupunit_id | String | The unique ID of the backup unit | |
pretty | Boolean | Controls whether response is pretty-printed (with indentation and new lines) | [optional][default to true] |
depth | Integer | Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on | [optional][default to 0] |
x_contract_number | Integer | Users having more than 1 contract need to provide contract number, against which all API requests should be executed | [optional] |
Return type
Authorization
Basic Authentication, Token Authentication
HTTP request headers
Content-Type: Not defined
Accept: application/json
backupunits_get
backupunits_get(opts)
List Backup Units
You can retrieve a complete list of backup Units that you have access to.
Examples
Using the backupunits_get_with_http_info variant
This returns an Array which contains the response data, status code and headers.
<Array(, Integer, Hash)> backupunits_get_with_http_info(opts)
Parameters
Name | Type | Description | Notes |
---|---|---|---|
pretty | Boolean | Controls whether response is pretty-printed (with indentation and new lines) | [optional][default to true] |
depth | Integer | Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on | [optional][default to 0] |
x_contract_number | Integer | Users having more than 1 contract need to provide contract number, against which all API requests should be executed | [optional] |
Return type
Authorization
Basic Authentication, Token Authentication
HTTP request headers
Content-Type: Not defined
Accept: application/json
backupunits_patch
backupunits_patch(backupunit_id, backup_unit_properties, opts)
Partially modify a Backup Unit
You can use update a backup Unit properties
Examples
Using the backupunits_patch_with_http_info variant
This returns an Array which contains the response data, status code and headers.
<Array(, Integer, Hash)> backupunits_patch_with_http_info(backupunit_id, backup_unit_properties, opts)
Parameters
Name | Type | Description | Notes |
---|---|---|---|
backupunit_id | String | The unique ID of the backup unit | |
backup_unit_properties | Modified backup Unit properties | ||
pretty | Boolean | Controls whether response is pretty-printed (with indentation and new lines) | [optional][default to true] |
depth | Integer | Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on | [optional][default to 0] |
x_contract_number | Integer | Users having more than 1 contract need to provide contract number, against which all API requests should be executed | [optional] |
Return type
Authorization
Basic Authentication, Token Authentication
HTTP request headers
Content-Type: application/json
Accept: application/json
backupunits_post
backupunits_post(backup_unit, 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
Using the backupunits_post_with_http_info variant
This returns an Array which contains the response data, status code and headers.
<Array(, Integer, Hash)> backupunits_post_with_http_info(backup_unit, opts)
Parameters
Name | Type | Description | Notes |
---|---|---|---|
backup_unit | Payload containing data to create a new Backup Unit | ||
pretty | Boolean | Controls whether response is pretty-printed (with indentation and new lines) | [optional][default to true] |
depth | Integer | Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on | [optional][default to 0] |
x_contract_number | Integer | Users having more than 1 contract need to provide contract number, against which all API requests should be executed | [optional] |
Return type
Authorization
Basic Authentication, Token Authentication
HTTP request headers
Content-Type: application/json
Accept: application/json
backupunits_put
backupunits_put(backupunit_id, backup_unit, opts)
Modify a Backup Unit
You can use update a backup Unit properties
Examples
Using the backupunits_put_with_http_info variant
This returns an Array which contains the response data, status code and headers.
<Array(, Integer, Hash)> backupunits_put_with_http_info(backupunit_id, backup_unit, opts)
Parameters
Name | Type | Description | Notes |
---|---|---|---|
backupunit_id | String | The unique ID of the backup unit | |
backup_unit | Modified backup Unit | ||
pretty | Boolean | Controls whether response is pretty-printed (with indentation and new lines) | [optional][default to true] |
depth | Integer | Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on | [optional][default to 0] |
x_contract_number | Integer | Users having more than 1 contract need to provide contract number, against which all API requests should be executed | [optional] |
Return type
Authorization
Basic Authentication, Token Authentication
HTTP request headers
Content-Type: application/json
Accept: application/json
backupunits_ssourl_get
backupunits_ssourl_get(backupunit_id, opts)
Returns a single signon URL for the specified backup Unit.
Returns a single signon URL for the specified backup Unit.
Examples
Using the backupunits_ssourl_get_with_http_info variant
This returns an Array which contains the response data, status code and headers.
<Array(, Integer, Hash)> backupunits_ssourl_get_with_http_info(backupunit_id, opts)
Parameters
Name | Type | Description | Notes |
---|---|---|---|
backupunit_id | String | The unique UUID of the backup unit | |
pretty | Boolean | Controls whether response is pretty-printed (with indentation and new lines) | [optional][default to true] |
x_contract_number | Integer | Users having more than 1 contract need to provide contract number, against which all API requests should be executed | [optional] |
Return type
Authorization
Basic Authentication, Token Authentication
HTTP request headers
Content-Type: Not defined
Accept: application/json
Last updated