# SnapshotsApi ## SnapshotsApi All URIs are relative to ** | Method | HTTP request | Description | | ------------------------------------------- | ---------------------------------- | -------------------------- | | [**snapshotsDelete**](#snapshotsdelete) | **DELETE** /snapshots/{snapshotId} | Delete snapshots | | [**snapshotsFindById**](#snapshotsfindbyid) | **GET** /snapshots/{snapshotId} | Retrieve snapshots by ID | | [**snapshotsGet**](#snapshotsget) | **GET** /snapshots | List snapshots | | [**snapshotsPatch**](#snapshotspatch) | **PATCH** /snapshots/{snapshotId} | Partially modify snapshots | | [**snapshotsPut**](#snapshotsput) | **PUT** /snapshots/{snapshotId} | Modify a Snapshot by ID | ## **snapshotsDelete** > snapshotsDelete(snapshotId, pretty, depth, xContractNumber) Delete snapshots Deletes the specified snapshot. #### Parameters | Name | Type | Description | Notes | | ------------------- | ----------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------ | | **snapshotId** | **String** | The unique ID of the snapshot. | | | **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 snapshotsDeleteWithHttpInfo which also returns the status code and the headers, if you don't need them you may use snapshotsDelete 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.SnapshotsApi; 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"); SnapshotsApi apiInstance = new SnapshotsApi(defaultClient); String snapshotId = "snapshotId_example"; // String | The unique ID of the snapshot. 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.snapshotsDeleteWithHttpInfo(snapshotId, pretty, depth, xContractNumber); } catch (ApiException e) { System.err.println("Exception when calling SnapshotsApi#snapshotsDelete"); 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.snapshotsDelete(snapshotId) .pretty(true) .depth(0) .xContractNumber(56) .execute(); System.out.println(result); } catch (ApiException e) { System.err.println("Exception when calling SnapshotsApi#snapshotsDelete"); System.err.println("Status code: " + e.getCode()); System.err.println("Reason: " + e.getResponseBody()); System.err.println("Response headers: " + e.getResponseHeaders()); e.printStackTrace(); } ``` ## **snapshotsFindById** > Snapshot snapshotsFindById(snapshotId, pretty, depth, xContractNumber) Retrieve snapshots by ID Retrieve the properties of the specified snapshot. #### Parameters | Name | Type | Description | Notes | | ------------------- | ----------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------ | | **snapshotId** | **String** | The unique ID of the snapshot. | | | **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 [**Snapshot**](https://docs.ionos.com/sections-test/java-sdk/cloud-api-java-sdk/models/snapshot) #### HTTP request headers * **Content-Type**: Not defined * **Accept**: application/json ⚠️ **Note**: the example bellow uses the snapshotsFindByIdWithHttpInfo which also returns the status code and the headers, if you don't need them you may use snapshotsFindById 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.SnapshotsApi; 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"); SnapshotsApi apiInstance = new SnapshotsApi(defaultClient); String snapshotId = "snapshotId_example"; // String | The unique ID of the snapshot. 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.snapshotsFindByIdWithHttpInfo(snapshotId, 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 SnapshotsApi#snapshotsFindById"); 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 { Snapshot result = apiInstance.snapshotsFindById(snapshotId) .pretty(true) .depth(0) .xContractNumber(56) .execute(); System.out.println(result); } catch (ApiException e) { System.err.println("Exception when calling SnapshotsApi#snapshotsFindById"); System.err.println("Status code: " + e.getCode()); System.err.println("Reason: " + e.getResponseBody()); System.err.println("Response headers: " + e.getResponseHeaders()); e.printStackTrace(); } ``` ## **snapshotsGet** > Snapshots snapshotsGet(pretty, depth, xContractNumber) List snapshots List all available snapshots. #### 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 [**Snapshots**](https://docs.ionos.com/sections-test/java-sdk/cloud-api-java-sdk/models/snapshots) #### HTTP request headers * **Content-Type**: Not defined * **Accept**: application/json ⚠️ **Note**: the example bellow uses the snapshotsGetWithHttpInfo which also returns the status code and the headers, if you don't need them you may use snapshotsGet 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.SnapshotsApi; 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"); SnapshotsApi apiInstance = new SnapshotsApi(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.snapshotsGetWithHttpInfo(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 SnapshotsApi#snapshotsGet"); 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 { Snapshots result = apiInstance.snapshotsGet() .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 SnapshotsApi#snapshotsGet"); System.err.println("Status code: " + e.getCode()); System.err.println("Reason: " + e.getResponseBody()); System.err.println("Response headers: " + e.getResponseHeaders()); e.printStackTrace(); } ``` ## **snapshotsPatch** > Snapshot snapshotsPatch(snapshotId, snapshot, pretty, depth, xContractNumber) Partially modify snapshots Update the properties of the specified snapshot. #### Parameters | Name | Type | Description | Notes | | ------------------- | -------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------ | | **snapshotId** | **String** | The unique ID of the snapshot. | | | **snapshot** | [**SnapshotProperties**](https://docs.ionos.com/sections-test/java-sdk/cloud-api-java-sdk/models/snapshotproperties) | The properties of the snapshot 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 [**Snapshot**](https://docs.ionos.com/sections-test/java-sdk/cloud-api-java-sdk/models/snapshot) #### HTTP request headers * **Content-Type**: application/json * **Accept**: application/json ⚠️ **Note**: the example bellow uses the snapshotsPatchWithHttpInfo which also returns the status code and the headers, if you don't need them you may use snapshotsPatch 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.SnapshotsApi; 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"); SnapshotsApi apiInstance = new SnapshotsApi(defaultClient); String snapshotId = "snapshotId_example"; // String | The unique ID of the snapshot. SnapshotProperties snapshot = new SnapshotProperties(); // SnapshotProperties | The properties of the snapshot 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.snapshotsPatchWithHttpInfo(snapshotId, snapshot, 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 SnapshotsApi#snapshotsPatch"); 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 { Snapshot result = apiInstance.snapshotsPatch(snapshotId, snapshot) .pretty(true) .depth(0) .xContractNumber(56) .execute(); System.out.println(result); } catch (ApiException e) { System.err.println("Exception when calling SnapshotsApi#snapshotsPatch"); System.err.println("Status code: " + e.getCode()); System.err.println("Reason: " + e.getResponseBody()); System.err.println("Response headers: " + e.getResponseHeaders()); e.printStackTrace(); } ``` ## **snapshotsPut** > Snapshot snapshotsPut(snapshotId, snapshot, pretty, depth, xContractNumber) Modify a Snapshot by ID Modifies the properties of the specified snapshot. #### Parameters | Name | Type | Description | Notes | | ------------------- | ------------------------------------------------------------------------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------ | | **snapshotId** | **String** | The unique ID of the snapshot. | | | **snapshot** | [**Snapshot**](https://docs.ionos.com/sections-test/java-sdk/cloud-api-java-sdk/models/snapshot) | The modified snapshot | | | **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 [**Snapshot**](https://docs.ionos.com/sections-test/java-sdk/cloud-api-java-sdk/models/snapshot) #### HTTP request headers * **Content-Type**: application/json * **Accept**: application/json ⚠️ **Note**: the example bellow uses the snapshotsPutWithHttpInfo which also returns the status code and the headers, if you don't need them you may use snapshotsPut 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.SnapshotsApi; 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"); SnapshotsApi apiInstance = new SnapshotsApi(defaultClient); String snapshotId = "snapshotId_example"; // String | The unique ID of the snapshot. properties = new SnapshotProperties(); // SnapshotProperties | snapshot = new Snapshot(SnapshotProperties); // Snapshot | The modified snapshot 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.snapshotsPutWithHttpInfo(snapshotId, snapshot, 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 SnapshotsApi#snapshotsPut"); 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 { Snapshot result = apiInstance.snapshotsPut(snapshotId, snapshot) .pretty(true) .depth(0) .xContractNumber(56) .execute(); System.out.println(result); } catch (ApiException e) { System.err.println("Exception when calling SnapshotsApi#snapshotsPut"); System.err.println("Status code: " + e.getCode()); System.err.println("Reason: " + e.getResponseBody()); System.err.println("Response headers: " + e.getResponseHeaders()); e.printStackTrace(); } ```