# BackupUnitsApi ## BackupUnitsApi All URIs are relative to ** | Method | HTTP request | Description | | ------------------------------------------------- | ------------------------------------------ | ------------------------------- | | [**backupunitsDelete**](#backupunitsdelete) | **DELETE** /backupunits/{backupunitId} | Delete backup units | | [**backupunitsFindById**](#backupunitsfindbyid) | **GET** /backupunits/{backupunitId} | Retrieve backup units | | [**backupunitsGet**](#backupunitsget) | **GET** /backupunits | List backup units | | [**backupunitsPatch**](#backupunitspatch) | **PATCH** /backupunits/{backupunitId} | Partially modify backup units | | [**backupunitsPost**](#backupunitspost) | **POST** /backupunits | Create backup units | | [**backupunitsPut**](#backupunitsput) | **PUT** /backupunits/{backupunitId} | Modify backup units | | [**backupunitsSsourlGet**](#backupunitsssourlget) | **GET** /backupunits/{backupunitId}/ssourl | Retrieve BU single sign-on URLs | ## **backupunitsDelete** > backupunitsDelete(backupunitId, pretty, depth, xContractNumber) 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 #### Parameters | Name | Type | Description | Notes | | ------------------- | ----------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------ | | **backupunitId** | **String** | The unique ID of the backup unit. | | | **pretty** | **Boolean** | Controls whether the response is pretty-printed (with indentations and new lines). | \[optional] \[default to true] | | **depth** | **Integer** | Controls the detail depth of the response objects. GET /datacenters/\[ID] - depth=0: Only direct properties are included; children (servers and other elements) 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] | | **xContractNumber** | **Integer** | Users with multiple contracts must provide the contract number, for which all API requests are to be executed. | \[optional] | #### Return type null (empty response body) #### HTTP request headers * **Content-Type**: Not defined * **Accept**: application/json ⚠️ **Note**: the example bellow uses the backupunitsDeleteWithHttpInfo which also returns the status code and the headers, if you don't need them you may use backupunitsDelete instead #### Example ```java // Import classes: import com.ionoscloud.ApiClient; import com.ionoscloud.ApiException; import com.ionoscloud.ApiResponse; import com.ionoscloud.Configuration; import com.ionoscloud.auth.*; import com.ionoscloud.model.*; import com.ionoscloud.api.BackupUnitsApi; public class Example { public static void main(String[] args) { ApiClient defaultClient = Configuration.getDefaultApiClient(); // Configure HTTP basic authorization: Basic Authentication HttpBasicAuth basicAuthentication = (HttpBasicAuth) defaultClient.getAuthentication("Basic Authentication"); basicAuthentication.setUsername("YOUR USERNAME"); basicAuthentication.setPassword("YOUR PASSWORD"); // Configure Api Key authorization: Token Authentication defaultClient.setApiKeyWithBearerPrefix("YOUR TOKEN"); BackupUnitsApi apiInstance = new BackupUnitsApi(defaultClient); String backupunitId = "backupunitId_example"; // String | The unique ID of the backup unit. Boolean pretty = true; // Boolean | Controls whether the response is pretty-printed (with indentations and new lines). Integer depth = 0; // Integer | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) 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 Integer xContractNumber = 56; // Integer | Users with multiple contracts must provide the contract number, for which all API requests are to be executed. try { apiInstance.backupunitsDeleteWithHttpInfo(backupunitId, pretty, depth, xContractNumber); } catch (ApiException e) { System.err.println("Exception when calling BackupUnitsApi#backupunitsDelete"); System.err.println("Status code: " + e.getCode()); System.err.println("Reason: " + e.getResponseBody()); System.err.println("Response headers: " + e.getResponseHeaders()); e.printStackTrace(); } } } ``` ⚠️ **Note**: for the example above, you need to provide all parameters to the method call. Null values will resolve to the API defaults. For convenience, you can alternatively use a builder, which allows to omit optional parameters: ```java try { apiInstance.backupunitsDelete(backupunitId) .pretty(true) .depth(0) .xContractNumber(56) .execute(); System.out.println(result); } catch (ApiException e) { System.err.println("Exception when calling BackupUnitsApi#backupunitsDelete"); System.err.println("Status code: " + e.getCode()); System.err.println("Reason: " + e.getResponseBody()); System.err.println("Response headers: " + e.getResponseHeaders()); e.printStackTrace(); } ``` ## **backupunitsFindById** > BackupUnit backupunitsFindById(backupunitId, pretty, depth, xContractNumber) Retrieve backup units Retrieve the properties of the specified backup unit. #### Parameters | Name | Type | Description | Notes | | ------------------- | ----------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------ | | **backupunitId** | **String** | The unique ID of the backup unit. | | | **pretty** | **Boolean** | Controls whether the response is pretty-printed (with indentations and new lines). | \[optional] \[default to true] | | **depth** | **Integer** | Controls the detail depth of the response objects. GET /datacenters/\[ID] - depth=0: Only direct properties are included; children (servers and other elements) 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] | | **xContractNumber** | **Integer** | Users with multiple contracts must provide the contract number, for which all API requests are to be executed. | \[optional] | #### Return type [**BackupUnit**](https://docs.ionos.com/sections-test/java-sdk/cloud-api-java-sdk/models/backupunit) #### HTTP request headers * **Content-Type**: Not defined * **Accept**: application/json ⚠️ **Note**: the example bellow uses the backupunitsFindByIdWithHttpInfo which also returns the status code and the headers, if you don't need them you may use backupunitsFindById instead #### Example ```java // Import classes: import com.ionoscloud.ApiClient; import com.ionoscloud.ApiException; import com.ionoscloud.ApiResponse; import com.ionoscloud.Configuration; import com.ionoscloud.auth.*; import com.ionoscloud.model.*; import com.ionoscloud.api.BackupUnitsApi; public class Example { public static void main(String[] args) { ApiClient defaultClient = Configuration.getDefaultApiClient(); // Configure HTTP basic authorization: Basic Authentication HttpBasicAuth basicAuthentication = (HttpBasicAuth) defaultClient.getAuthentication("Basic Authentication"); basicAuthentication.setUsername("YOUR USERNAME"); basicAuthentication.setPassword("YOUR PASSWORD"); // Configure Api Key authorization: Token Authentication defaultClient.setApiKeyWithBearerPrefix("YOUR TOKEN"); BackupUnitsApi apiInstance = new BackupUnitsApi(defaultClient); String backupunitId = "backupunitId_example"; // String | The unique ID of the backup unit. Boolean pretty = true; // Boolean | Controls whether the response is pretty-printed (with indentations and new lines). Integer depth = 0; // Integer | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) 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 Integer xContractNumber = 56; // Integer | Users with multiple contracts must provide the contract number, for which all API requests are to be executed. try { ApiResponse result = apiInstance.backupunitsFindByIdWithHttpInfo(backupunitId, pretty, depth, xContractNumber); System.out.println("Response: " + result.getData()); System.out.println("Status Code: " + result.getStatusCode()); System.out.println("Headers: " + result.getHeaders()); } catch (ApiException e) { System.err.println("Exception when calling BackupUnitsApi#backupunitsFindById"); System.err.println("Status code: " + e.getCode()); System.err.println("Reason: " + e.getResponseBody()); System.err.println("Response headers: " + e.getResponseHeaders()); e.printStackTrace(); } } } ``` ⚠️ **Note**: for the example above, you need to provide all parameters to the method call. Null values will resolve to the API defaults. For convenience, you can alternatively use a builder, which allows to omit optional parameters: ```java try { BackupUnit result = apiInstance.backupunitsFindById(backupunitId) .pretty(true) .depth(0) .xContractNumber(56) .execute(); System.out.println(result); } catch (ApiException e) { System.err.println("Exception when calling BackupUnitsApi#backupunitsFindById"); System.err.println("Status code: " + e.getCode()); System.err.println("Reason: " + e.getResponseBody()); System.err.println("Response headers: " + e.getResponseHeaders()); e.printStackTrace(); } ``` ## **backupunitsGet** > BackupUnits backupunitsGet(pretty, depth, xContractNumber) List backup units List all available backup units. #### Parameters | Name | Type | Description | Notes | | ------------------- | -------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------ | | **pretty** | **Boolean** | Controls whether the response is pretty-printed (with indentations and new lines). | \[optional] \[default to true] | | **depth** | **Integer** | Controls the detail depth of the response objects. GET /datacenters/\[ID] - depth=0: Only direct properties are included; children (servers and other elements) 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] | | **xContractNumber** | **Integer** | Users with multiple contracts must provide the contract number, for which all API requests are to be executed. | \[optional] | | orderBy | String | Sorts the results alphanumerically in ascending order based on the specified property. | \[optional] | | maxResults | Integer | Limits the number of results returned. | \[optional] | | filters | Map\ | Limit results to those containing a matching value for a specific property. | \[optional] | #### Return type [**BackupUnits**](https://docs.ionos.com/sections-test/java-sdk/cloud-api-java-sdk/models/backupunits) #### HTTP request headers * **Content-Type**: Not defined * **Accept**: application/json ⚠️ **Note**: the example bellow uses the backupunitsGetWithHttpInfo which also returns the status code and the headers, if you don't need them you may use backupunitsGet instead #### Example ```java // Import classes: import com.ionoscloud.ApiClient; import com.ionoscloud.ApiException; import com.ionoscloud.ApiResponse; import com.ionoscloud.Configuration; import com.ionoscloud.auth.*; import com.ionoscloud.model.*; import com.ionoscloud.api.BackupUnitsApi; public class Example { public static void main(String[] args) { ApiClient defaultClient = Configuration.getDefaultApiClient(); // Configure HTTP basic authorization: Basic Authentication HttpBasicAuth basicAuthentication = (HttpBasicAuth) defaultClient.getAuthentication("Basic Authentication"); basicAuthentication.setUsername("YOUR USERNAME"); basicAuthentication.setPassword("YOUR PASSWORD"); // Configure Api Key authorization: Token Authentication defaultClient.setApiKeyWithBearerPrefix("YOUR TOKEN"); BackupUnitsApi apiInstance = new BackupUnitsApi(defaultClient); Boolean pretty = true; // Boolean | Controls whether the response is pretty-printed (with indentations and new lines). Integer depth = 0; // Integer | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) 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 Integer xContractNumber = 56; // Integer | Users with multiple contracts must provide the contract number, for which all API requests are to be executed. String orderBy = "orderBy_example"; // String | Order by field Integer maxResults = "maxResults_example"; // Integer | Maximum number of results to return Map filters = new HashMap(); // Map | Filter results by field try { ApiResponse result = apiInstance.backupunitsGetWithHttpInfo(pretty, depth, xContractNumber, orderBy, maxResults, filters); System.out.println("Response: " + result.getData()); System.out.println("Status Code: " + result.getStatusCode()); System.out.println("Headers: " + result.getHeaders()); } catch (ApiException e) { System.err.println("Exception when calling BackupUnitsApi#backupunitsGet"); System.err.println("Status code: " + e.getCode()); System.err.println("Reason: " + e.getResponseBody()); System.err.println("Response headers: " + e.getResponseHeaders()); e.printStackTrace(); } } } ``` ⚠️ **Note**: for the example above, you need to provide all parameters to the method call. Null values will resolve to the API defaults. For convenience, you can alternatively use a builder, which allows to omit optional parameters: ```java try { BackupUnits result = apiInstance.backupunitsGet() .pretty(true) .depth(0) .xContractNumber(56) .orderBy("orderBy_example") .maxResults(5) .filters(filters) .execute(); System.out.println(result); } catch (ApiException e) { System.err.println("Exception when calling BackupUnitsApi#backupunitsGet"); System.err.println("Status code: " + e.getCode()); System.err.println("Reason: " + e.getResponseBody()); System.err.println("Response headers: " + e.getResponseHeaders()); e.printStackTrace(); } ``` ## **backupunitsPatch** > BackupUnit backupunitsPatch(backupunitId, backupUnit, pretty, depth, xContractNumber) Partially modify backup units Update the properties of the specified backup unit. #### Parameters | Name | Type | Description | Notes | | ------------------- | ------------------------------------------------------------------------------------------------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------ | | **backupunitId** | **String** | The unique ID of the backup unit. | | | **backupUnit** | [**BackupUnitProperties**](https://docs.ionos.com/sections-test/java-sdk/cloud-api-java-sdk/models/backupunitproperties) | The properties of the backup unit to be updated. | | | **pretty** | **Boolean** | Controls whether the response is pretty-printed (with indentations and new lines). | \[optional] \[default to true] | | **depth** | **Integer** | Controls the detail depth of the response objects. GET /datacenters/\[ID] - depth=0: Only direct properties are included; children (servers and other elements) 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] | | **xContractNumber** | **Integer** | Users with multiple contracts must provide the contract number, for which all API requests are to be executed. | \[optional] | #### Return type [**BackupUnit**](https://docs.ionos.com/sections-test/java-sdk/cloud-api-java-sdk/models/backupunit) #### HTTP request headers * **Content-Type**: application/json * **Accept**: application/json ⚠️ **Note**: the example bellow uses the backupunitsPatchWithHttpInfo which also returns the status code and the headers, if you don't need them you may use backupunitsPatch instead #### Example ```java // Import classes: import com.ionoscloud.ApiClient; import com.ionoscloud.ApiException; import com.ionoscloud.ApiResponse; import com.ionoscloud.Configuration; import com.ionoscloud.auth.*; import com.ionoscloud.model.*; import com.ionoscloud.api.BackupUnitsApi; public class Example { public static void main(String[] args) { ApiClient defaultClient = Configuration.getDefaultApiClient(); // Configure HTTP basic authorization: Basic Authentication HttpBasicAuth basicAuthentication = (HttpBasicAuth) defaultClient.getAuthentication("Basic Authentication"); basicAuthentication.setUsername("YOUR USERNAME"); basicAuthentication.setPassword("YOUR PASSWORD"); // Configure Api Key authorization: Token Authentication defaultClient.setApiKeyWithBearerPrefix("YOUR TOKEN"); BackupUnitsApi apiInstance = new BackupUnitsApi(defaultClient); String backupunitId = "backupunitId_example"; // String | The unique ID of the backup unit. name = new String(); // String | The name of the resource (alphanumeric characters only). backupUnit = new BackupUnitProperties(String); // BackupUnitProperties | The properties of the backup unit to be updated. Boolean pretty = true; // Boolean | Controls whether the response is pretty-printed (with indentations and new lines). Integer depth = 0; // Integer | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) 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 Integer xContractNumber = 56; // Integer | Users with multiple contracts must provide the contract number, for which all API requests are to be executed. try { ApiResponse result = apiInstance.backupunitsPatchWithHttpInfo(backupunitId, backupUnit, pretty, depth, xContractNumber); System.out.println("Response: " + result.getData()); System.out.println("Status Code: " + result.getStatusCode()); System.out.println("Headers: " + result.getHeaders()); } catch (ApiException e) { System.err.println("Exception when calling BackupUnitsApi#backupunitsPatch"); System.err.println("Status code: " + e.getCode()); System.err.println("Reason: " + e.getResponseBody()); System.err.println("Response headers: " + e.getResponseHeaders()); e.printStackTrace(); } } } ``` ⚠️ **Note**: for the example above, you need to provide all parameters to the method call. Null values will resolve to the API defaults. For convenience, you can alternatively use a builder, which allows to omit optional parameters: ```java try { BackupUnit result = apiInstance.backupunitsPatch(backupunitId, backupUnit) .pretty(true) .depth(0) .xContractNumber(56) .execute(); System.out.println(result); } catch (ApiException e) { System.err.println("Exception when calling BackupUnitsApi#backupunitsPatch"); System.err.println("Status code: " + e.getCode()); System.err.println("Reason: " + e.getResponseBody()); System.err.println("Response headers: " + e.getResponseHeaders()); e.printStackTrace(); } ``` ## **backupunitsPost** > BackupUnit backupunitsPost(backupUnit, pretty, depth, xContractNumber) 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. #### Parameters | Name | Type | Description | Notes | | ------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------ | | **backupUnit** | [**BackupUnit**](https://docs.ionos.com/sections-test/java-sdk/cloud-api-java-sdk/models/backupunit) | The backup unit to create. | | | **pretty** | **Boolean** | Controls whether the response is pretty-printed (with indentations and new lines). | \[optional] \[default to true] | | **depth** | **Integer** | Controls the detail depth of the response objects. GET /datacenters/\[ID] - depth=0: Only direct properties are included; children (servers and other elements) 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] | | **xContractNumber** | **Integer** | Users with multiple contracts must provide the contract number, for which all API requests are to be executed. | \[optional] | #### Return type [**BackupUnit**](https://docs.ionos.com/sections-test/java-sdk/cloud-api-java-sdk/models/backupunit) #### HTTP request headers * **Content-Type**: application/json * **Accept**: application/json ⚠️ **Note**: the example bellow uses the backupunitsPostWithHttpInfo which also returns the status code and the headers, if you don't need them you may use backupunitsPost instead #### Example ```java // Import classes: import com.ionoscloud.ApiClient; import com.ionoscloud.ApiException; import com.ionoscloud.ApiResponse; import com.ionoscloud.Configuration; import com.ionoscloud.auth.*; import com.ionoscloud.model.*; import com.ionoscloud.api.BackupUnitsApi; public class Example { public static void main(String[] args) { ApiClient defaultClient = Configuration.getDefaultApiClient(); // Configure HTTP basic authorization: Basic Authentication HttpBasicAuth basicAuthentication = (HttpBasicAuth) defaultClient.getAuthentication("Basic Authentication"); basicAuthentication.setUsername("YOUR USERNAME"); basicAuthentication.setPassword("YOUR PASSWORD"); // Configure Api Key authorization: Token Authentication defaultClient.setApiKeyWithBearerPrefix("YOUR TOKEN"); BackupUnitsApi apiInstance = new BackupUnitsApi(defaultClient); properties = new BackupUnitProperties(); // BackupUnitProperties | backupUnit = new BackupUnit(BackupUnitProperties); // BackupUnit | The backup unit to create. Boolean pretty = true; // Boolean | Controls whether the response is pretty-printed (with indentations and new lines). Integer depth = 0; // Integer | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) 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 Integer xContractNumber = 56; // Integer | Users with multiple contracts must provide the contract number, for which all API requests are to be executed. try { ApiResponse result = apiInstance.backupunitsPostWithHttpInfo(backupUnit, pretty, depth, xContractNumber); System.out.println("Response: " + result.getData()); System.out.println("Status Code: " + result.getStatusCode()); System.out.println("Headers: " + result.getHeaders()); } catch (ApiException e) { System.err.println("Exception when calling BackupUnitsApi#backupunitsPost"); System.err.println("Status code: " + e.getCode()); System.err.println("Reason: " + e.getResponseBody()); System.err.println("Response headers: " + e.getResponseHeaders()); e.printStackTrace(); } } } ``` ⚠️ **Note**: for the example above, you need to provide all parameters to the method call. Null values will resolve to the API defaults. For convenience, you can alternatively use a builder, which allows to omit optional parameters: ```java try { BackupUnit result = apiInstance.backupunitsPost(backupUnit) .pretty(true) .depth(0) .xContractNumber(56) .execute(); System.out.println(result); } catch (ApiException e) { System.err.println("Exception when calling BackupUnitsApi#backupunitsPost"); System.err.println("Status code: " + e.getCode()); System.err.println("Reason: " + e.getResponseBody()); System.err.println("Response headers: " + e.getResponseHeaders()); e.printStackTrace(); } ``` ## **backupunitsPut** > BackupUnit backupunitsPut(backupunitId, backupUnit, pretty, depth, xContractNumber) Modify backup units Modify the properties of the specified backup unit. #### Parameters | Name | Type | Description | Notes | | ------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------ | | **backupunitId** | **String** | The unique ID of the backup unit. | | | **backupUnit** | [**BackupUnit**](https://docs.ionos.com/sections-test/java-sdk/cloud-api-java-sdk/models/backupunit) | The modified backup unit. | | | **pretty** | **Boolean** | Controls whether the response is pretty-printed (with indentations and new lines). | \[optional] \[default to true] | | **depth** | **Integer** | Controls the detail depth of the response objects. GET /datacenters/\[ID] - depth=0: Only direct properties are included; children (servers and other elements) 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] | | **xContractNumber** | **Integer** | Users with multiple contracts must provide the contract number, for which all API requests are to be executed. | \[optional] | #### Return type [**BackupUnit**](https://docs.ionos.com/sections-test/java-sdk/cloud-api-java-sdk/models/backupunit) #### HTTP request headers * **Content-Type**: application/json * **Accept**: application/json ⚠️ **Note**: the example bellow uses the backupunitsPutWithHttpInfo which also returns the status code and the headers, if you don't need them you may use backupunitsPut instead #### Example ```java // Import classes: import com.ionoscloud.ApiClient; import com.ionoscloud.ApiException; import com.ionoscloud.ApiResponse; import com.ionoscloud.Configuration; import com.ionoscloud.auth.*; import com.ionoscloud.model.*; import com.ionoscloud.api.BackupUnitsApi; public class Example { public static void main(String[] args) { ApiClient defaultClient = Configuration.getDefaultApiClient(); // Configure HTTP basic authorization: Basic Authentication HttpBasicAuth basicAuthentication = (HttpBasicAuth) defaultClient.getAuthentication("Basic Authentication"); basicAuthentication.setUsername("YOUR USERNAME"); basicAuthentication.setPassword("YOUR PASSWORD"); // Configure Api Key authorization: Token Authentication defaultClient.setApiKeyWithBearerPrefix("YOUR TOKEN"); BackupUnitsApi apiInstance = new BackupUnitsApi(defaultClient); String backupunitId = "backupunitId_example"; // String | The unique ID of the backup unit. properties = new BackupUnitProperties(); // BackupUnitProperties | backupUnit = new BackupUnit(BackupUnitProperties); // BackupUnit | The modified backup unit. Boolean pretty = true; // Boolean | Controls whether the response is pretty-printed (with indentations and new lines). Integer depth = 0; // Integer | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) 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 Integer xContractNumber = 56; // Integer | Users with multiple contracts must provide the contract number, for which all API requests are to be executed. try { ApiResponse result = apiInstance.backupunitsPutWithHttpInfo(backupunitId, backupUnit, pretty, depth, xContractNumber); System.out.println("Response: " + result.getData()); System.out.println("Status Code: " + result.getStatusCode()); System.out.println("Headers: " + result.getHeaders()); } catch (ApiException e) { System.err.println("Exception when calling BackupUnitsApi#backupunitsPut"); System.err.println("Status code: " + e.getCode()); System.err.println("Reason: " + e.getResponseBody()); System.err.println("Response headers: " + e.getResponseHeaders()); e.printStackTrace(); } } } ``` ⚠️ **Note**: for the example above, you need to provide all parameters to the method call. Null values will resolve to the API defaults. For convenience, you can alternatively use a builder, which allows to omit optional parameters: ```java try { BackupUnit result = apiInstance.backupunitsPut(backupunitId, backupUnit) .pretty(true) .depth(0) .xContractNumber(56) .execute(); System.out.println(result); } catch (ApiException e) { System.err.println("Exception when calling BackupUnitsApi#backupunitsPut"); System.err.println("Status code: " + e.getCode()); System.err.println("Reason: " + e.getResponseBody()); System.err.println("Response headers: " + e.getResponseHeaders()); e.printStackTrace(); } ``` ## **backupunitsSsourlGet** > BackupUnitSSO backupunitsSsourlGet(backupunitId, pretty, xContractNumber) Retrieve BU single sign-on URLs Retrieve a single sign-on URL for the specified backup unit. #### Parameters | Name | Type | Description | Notes | | ------------------- | -------------------- | -------------------------------------------------------------------------------------------------------------- | ------------------------------ | | **backupunitId** | **String** | The unique ID of the backup unit. | | | **pretty** | **Boolean** | Controls whether the response is pretty-printed (with indentations and new lines). | \[optional] \[default to true] | | **xContractNumber** | **Integer** | Users with multiple contracts must provide the contract number, for which all API requests are to be executed. | \[optional] | | orderBy | String | Sorts the results alphanumerically in ascending order based on the specified property. | \[optional] | | maxResults | Integer | Limits the number of results returned. | \[optional] | | filters | Map\ | Limit results to those containing a matching value for a specific property. | \[optional] | #### Return type [**BackupUnitSSO**](https://docs.ionos.com/sections-test/java-sdk/cloud-api-java-sdk/models/backupunitsso) #### HTTP request headers * **Content-Type**: Not defined * **Accept**: application/json ⚠️ **Note**: the example bellow uses the backupunitsSsourlGetWithHttpInfo which also returns the status code and the headers, if you don't need them you may use backupunitsSsourlGet instead #### Example ```java // Import classes: import com.ionoscloud.ApiClient; import com.ionoscloud.ApiException; import com.ionoscloud.ApiResponse; import com.ionoscloud.Configuration; import com.ionoscloud.auth.*; import com.ionoscloud.model.*; import com.ionoscloud.api.BackupUnitsApi; public class Example { public static void main(String[] args) { ApiClient defaultClient = Configuration.getDefaultApiClient(); // Configure HTTP basic authorization: Basic Authentication HttpBasicAuth basicAuthentication = (HttpBasicAuth) defaultClient.getAuthentication("Basic Authentication"); basicAuthentication.setUsername("YOUR USERNAME"); basicAuthentication.setPassword("YOUR PASSWORD"); // Configure Api Key authorization: Token Authentication defaultClient.setApiKeyWithBearerPrefix("YOUR TOKEN"); BackupUnitsApi apiInstance = new BackupUnitsApi(defaultClient); String backupunitId = "backupunitId_example"; // String | The unique ID of the backup unit. Boolean pretty = true; // Boolean | Controls whether the response is pretty-printed (with indentations and new lines). Integer xContractNumber = 56; // Integer | Users with multiple contracts must provide the contract number, for which all API requests are to be executed. String orderBy = "orderBy_example"; // String | Order by field Integer maxResults = "maxResults_example"; // Integer | Maximum number of results to return Map filters = new HashMap(); // Map | Filter results by field try { ApiResponse result = apiInstance.backupunitsSsourlGetWithHttpInfo(backupunitId, pretty, xContractNumber, orderBy, maxResults, filters); System.out.println("Response: " + result.getData()); System.out.println("Status Code: " + result.getStatusCode()); System.out.println("Headers: " + result.getHeaders()); } catch (ApiException e) { System.err.println("Exception when calling BackupUnitsApi#backupunitsSsourlGet"); System.err.println("Status code: " + e.getCode()); System.err.println("Reason: " + e.getResponseBody()); System.err.println("Response headers: " + e.getResponseHeaders()); e.printStackTrace(); } } } ``` ⚠️ **Note**: for the example above, you need to provide all parameters to the method call. Null values will resolve to the API defaults. For convenience, you can alternatively use a builder, which allows to omit optional parameters: ```java try { BackupUnitSSO result = apiInstance.backupunitsSsourlGet(backupunitId) .pretty(true) .xContractNumber(56) .orderBy("orderBy_example") .maxResults(5) .filters(filters) .execute(); System.out.println(result); } catch (ApiException e) { System.err.println("Exception when calling BackupUnitsApi#backupunitsSsourlGet"); System.err.println("Status code: " + e.getCode()); System.err.println("Reason: " + e.getResponseBody()); System.err.println("Response headers: " + e.getResponseHeaders()); e.printStackTrace(); } ```