# VolumesApi ## VolumesApi All URIs are relative to ** | Method | HTTP request | Description | | ----------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------ | ------------------------ | | [**datacenters\_volumes\_create\_snapshot\_post**](#datacenters_volumes_create_snapshot_post) | **POST** /datacenters/{datacenterId}/volumes/{volumeId}/create-snapshot | Create volume snapshots | | [**datacenters\_volumes\_delete**](#datacenters_volumes_delete) | **DELETE** /datacenters/{datacenterId}/volumes/{volumeId} | Delete volumes | | [**datacenters\_volumes\_find\_by\_id**](#datacenters_volumes_find_by_id) | **GET** /datacenters/{datacenterId}/volumes/{volumeId} | Retrieve volumes | | [**datacenters\_volumes\_get**](#datacenters_volumes_get) | **GET** /datacenters/{datacenterId}/volumes | List volumes | | [**datacenters\_volumes\_patch**](#datacenters_volumes_patch) | **PATCH** /datacenters/{datacenterId}/volumes/{volumeId} | Partially modify volumes | | [**datacenters\_volumes\_post**](#datacenters_volumes_post) | **POST** /datacenters/{datacenterId}/volumes | Create a Volume | | [**datacenters\_volumes\_put**](#datacenters_volumes_put) | **PUT** /datacenters/{datacenterId}/volumes/{volumeId} | Modify a Volume by ID | | [**datacenters\_volumes\_restore\_snapshot\_post**](#datacenters_volumes_restore_snapshot_post) | **POST** /datacenters/{datacenterId}/volumes/{volumeId}/restore-snapshot | Restore volume snapshots | ## **datacenters\_volumes\_create\_snapshot\_post** > Snapshot datacenters\_volumes\_create\_snapshot\_post(datacenter\_id, volume\_id, pretty=pretty, depth=depth, x\_contract\_number=x\_contract\_number, name=name, description=description, sec\_auth\_protection=sec\_auth\_protection, licence\_type=licence\_type) Create volume snapshots Create a snapshot of the specified volume within the data center; this snapshot can later be used to restore this volume. #### Example ```python from __future__ import print_function import time import ionoscloud from ionoscloud.rest import ApiException # Defining the host is optional and defaults to https://api.ionos.com/cloudapi/v6 configuration = ionoscloud.Configuration( host = 'https://api.ionos.com/cloudapi/v6', ) # Example of configuring HTTP Basic Authorization configuration.username = 'YOUR_USERNAME' configuration.password = 'YOUR_PASSWORD' with ionoscloud.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = ionoscloud.VolumesApi(api_client) datacenter_id = 'datacenter_id_example' # str | The unique ID of the data center. volume_id = 'volume_id_example' # str | The unique ID of the volume. try: # Create volume snapshots api_response = api_instance.datacenters_volumes_create_snapshot_post(datacenter_id, volume_id) print(api_response) except ApiException as e: print('Exception when calling VolumesApi.datacenters_volumes_create_snapshot_post: %s\n' % e) ``` #### Parameters | Name | Type | Description | Notes | | ------------------------- | -------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------ | | **datacenter\_id** | **str** | The unique ID of the data center. | | | **volume\_id** | **str** | The unique ID of the volume. | | | **pretty** | **bool** | Controls whether the response is pretty-printed (with indentations and new lines). | \[optional] \[default to True] | | **depth** | **int** | 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] | | **x\_contract\_number** | **int** | Users with multiple contracts must provide the contract number, for which all API requests are to be executed. | \[optional] | | **name** | **str** | Snapshot name | \[optional] | | **description** | **str** | Snapshot description | \[optional] | | **sec\_auth\_protection** | **bool** | Flag for enabling extra protection for this snapshot, such as two-step verification. | \[optional] | | **licence\_type** | **str** | The OS type for this snapshot. | \[optional] | #### Return type [**Snapshot**](https://docs.ionos.com/sections-test/python-sdk/cloud-api-python-sdk/models/snapshot) #### Authorization Basic Authentication, Token Authentication #### HTTP request headers * **Content-Type**: application/x-www-form-urlencoded * **Accept**: application/json ## **datacenters\_volumes\_delete** > datacenters\_volumes\_delete(datacenter\_id, volume\_id, pretty=pretty, depth=depth, x\_contract\_number=x\_contract\_number) Delete volumes Delete the specified volume within the data center. Use with caution, the volume will be permanently removed! #### Example ```python from __future__ import print_function import time import ionoscloud from ionoscloud.rest import ApiException # Defining the host is optional and defaults to https://api.ionos.com/cloudapi/v6 configuration = ionoscloud.Configuration( host = 'https://api.ionos.com/cloudapi/v6', ) # Example of configuring HTTP Basic Authorization configuration.username = 'YOUR_USERNAME' configuration.password = 'YOUR_PASSWORD' with ionoscloud.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = ionoscloud.VolumesApi(api_client) datacenter_id = 'datacenter_id_example' # str | The unique ID of the data center. volume_id = 'volume_id_example' # str | The unique ID of the volume. try: # Delete volumes api_instance.datacenters_volumes_delete(datacenter_id, volume_id) except ApiException as e: print('Exception when calling VolumesApi.datacenters_volumes_delete: %s\n' % e) ``` #### Parameters | Name | Type | Description | Notes | | ----------------------- | -------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------ | | **datacenter\_id** | **str** | The unique ID of the data center. | | | **volume\_id** | **str** | The unique ID of the volume. | | | **pretty** | **bool** | Controls whether the response is pretty-printed (with indentations and new lines). | \[optional] \[default to True] | | **depth** | **int** | 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] | | **x\_contract\_number** | **int** | Users with multiple contracts must provide the contract number, for which all API requests are to be executed. | \[optional] | #### Return type void (empty response body) #### Authorization Basic Authentication, Token Authentication #### HTTP request headers * **Content-Type**: Not defined * **Accept**: application/json ## **datacenters\_volumes\_find\_by\_id** > Volume datacenters\_volumes\_find\_by\_id(datacenter\_id, volume\_id, pretty=pretty, depth=depth, x\_contract\_number=x\_contract\_number) Retrieve volumes Retrieve the properties of the specified volume within the data center. #### Example ```python from __future__ import print_function import time import ionoscloud from ionoscloud.rest import ApiException # Defining the host is optional and defaults to https://api.ionos.com/cloudapi/v6 configuration = ionoscloud.Configuration( host = 'https://api.ionos.com/cloudapi/v6', ) # Example of configuring HTTP Basic Authorization configuration.username = 'YOUR_USERNAME' configuration.password = 'YOUR_PASSWORD' with ionoscloud.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = ionoscloud.VolumesApi(api_client) datacenter_id = 'datacenter_id_example' # str | The unique ID of the data center. volume_id = 'volume_id_example' # str | The unique ID of the volume. try: # Retrieve volumes api_response = api_instance.datacenters_volumes_find_by_id(datacenter_id, volume_id) print(api_response) except ApiException as e: print('Exception when calling VolumesApi.datacenters_volumes_find_by_id: %s\n' % e) ``` #### Parameters | Name | Type | Description | Notes | | ----------------------- | -------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------ | | **datacenter\_id** | **str** | The unique ID of the data center. | | | **volume\_id** | **str** | The unique ID of the volume. | | | **pretty** | **bool** | Controls whether the response is pretty-printed (with indentations and new lines). | \[optional] \[default to True] | | **depth** | **int** | 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] | | **x\_contract\_number** | **int** | Users with multiple contracts must provide the contract number, for which all API requests are to be executed. | \[optional] | #### Return type [**Volume**](https://docs.ionos.com/sections-test/python-sdk/cloud-api-python-sdk/models/volume) #### Authorization Basic Authentication, Token Authentication #### HTTP request headers * **Content-Type**: Not defined * **Accept**: application/json ## **datacenters\_volumes\_get** > Volumes datacenters\_volumes\_get(datacenter\_id, pretty=pretty, depth=depth, x\_contract\_number=x\_contract\_number, offset=offset, limit=limit) List volumes List all the volumes within the data center. #### Example ```python from __future__ import print_function import time import ionoscloud from ionoscloud.rest import ApiException # Defining the host is optional and defaults to https://api.ionos.com/cloudapi/v6 configuration = ionoscloud.Configuration( host = 'https://api.ionos.com/cloudapi/v6', ) # Example of configuring HTTP Basic Authorization configuration.username = 'YOUR_USERNAME' configuration.password = 'YOUR_PASSWORD' with ionoscloud.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = ionoscloud.VolumesApi(api_client) datacenter_id = 'datacenter_id_example' # str | The unique ID of the data center. try: # List volumes api_response = api_instance.datacenters_volumes_get(datacenter_id) print(api_response) except ApiException as e: print('Exception when calling VolumesApi.datacenters_volumes_get: %s\n' % e) ``` #### Parameters | Name | Type | Description | Notes | | ----------------------- | -------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------ | | **datacenter\_id** | **str** | The unique ID of the data center. | | | **pretty** | **bool** | Controls whether the response is pretty-printed (with indentations and new lines). | \[optional] \[default to True] | | **depth** | **int** | 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] | | **x\_contract\_number** | **int** | Users with multiple contracts must provide the contract number, for which all API requests are to be executed. | \[optional] | | **offset** | **int** | The first element (from the complete list of the elements) to include in the response (used together with \\limit\\ for pagination). | \[optional] \[default to 0] | | **limit** | **int** | The maximum number of elements to return (use together with offset for pagination). | \[optional] \[default to 1000] | #### Return type [**Volumes**](https://docs.ionos.com/sections-test/python-sdk/cloud-api-python-sdk/models/volumes) #### Authorization Basic Authentication, Token Authentication #### HTTP request headers * **Content-Type**: Not defined * **Accept**: application/json ## **datacenters\_volumes\_patch** > Volume datacenters\_volumes\_patch(datacenter\_id, volume\_id, volume, pretty=pretty, depth=depth, x\_contract\_number=x\_contract\_number) Partially modify volumes Update the properties of the specified storage volume within the data center. #### Example ```python from __future__ import print_function import time import ionoscloud from ionoscloud.rest import ApiException # Defining the host is optional and defaults to https://api.ionos.com/cloudapi/v6 configuration = ionoscloud.Configuration( host = 'https://api.ionos.com/cloudapi/v6', ) # Example of configuring HTTP Basic Authorization configuration.username = 'YOUR_USERNAME' configuration.password = 'YOUR_PASSWORD' with ionoscloud.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = ionoscloud.VolumesApi(api_client) datacenter_id = 'datacenter_id_example' # str | The unique ID of the data center. volume_id = 'volume_id_example' # str | The unique ID of the volume. volume = ionoscloud.VolumeProperties() # VolumeProperties | The properties of the volume to be updated. try: # Partially modify volumes api_response = api_instance.datacenters_volumes_patch(datacenter_id, volume_id, volume) print(api_response) except ApiException as e: print('Exception when calling VolumesApi.datacenters_volumes_patch: %s\n' % e) ``` #### Parameters | Name | Type | Description | Notes | | ----------------------- | -------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------ | | **datacenter\_id** | **str** | The unique ID of the data center. | | | **volume\_id** | **str** | The unique ID of the volume. | | | **volume** | [**VolumeProperties**](https://docs.ionos.com/sections-test/python-sdk/cloud-api-python-sdk/models/volumeproperties) | The properties of the volume to be updated. | | | **pretty** | **bool** | Controls whether the response is pretty-printed (with indentations and new lines). | \[optional] \[default to True] | | **depth** | **int** | 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] | | **x\_contract\_number** | **int** | Users with multiple contracts must provide the contract number, for which all API requests are to be executed. | \[optional] | #### Return type [**Volume**](https://docs.ionos.com/sections-test/python-sdk/cloud-api-python-sdk/models/volume) #### Authorization Basic Authentication, Token Authentication #### HTTP request headers * **Content-Type**: application/json * **Accept**: application/json ## **datacenters\_volumes\_post** > Volume datacenters\_volumes\_post(datacenter\_id, volume, pretty=pretty, depth=depth, x\_contract\_number=x\_contract\_number) Create a Volume Creates a storage volume within the specified data center. The volume will not be attached! Attaching volumes is described in the Servers section. #### Example ```python from __future__ import print_function import time import ionoscloud from ionoscloud.rest import ApiException # Defining the host is optional and defaults to https://api.ionos.com/cloudapi/v6 configuration = ionoscloud.Configuration( host = 'https://api.ionos.com/cloudapi/v6', ) # Example of configuring HTTP Basic Authorization configuration.username = 'YOUR_USERNAME' configuration.password = 'YOUR_PASSWORD' with ionoscloud.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = ionoscloud.VolumesApi(api_client) datacenter_id = 'datacenter_id_example' # str | The unique ID of the data center. volume = ionoscloud.Volume() # Volume | The volume to create. try: # Create a Volume api_response = api_instance.datacenters_volumes_post(datacenter_id, volume) print(api_response) except ApiException as e: print('Exception when calling VolumesApi.datacenters_volumes_post: %s\n' % e) ``` #### Parameters | Name | Type | Description | Notes | | ----------------------- | ------------------------------------------------------------------------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------ | | **datacenter\_id** | **str** | The unique ID of the data center. | | | **volume** | [**Volume**](https://docs.ionos.com/sections-test/python-sdk/cloud-api-python-sdk/models/volume) | The volume to create. | | | **pretty** | **bool** | Controls whether the response is pretty-printed (with indentations and new lines). | \[optional] \[default to True] | | **depth** | **int** | 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] | | **x\_contract\_number** | **int** | Users with multiple contracts must provide the contract number, for which all API requests are to be executed. | \[optional] | #### Return type [**Volume**](https://docs.ionos.com/sections-test/python-sdk/cloud-api-python-sdk/models/volume) #### Authorization Basic Authentication, Token Authentication #### HTTP request headers * **Content-Type**: application/json * **Accept**: application/json ## **datacenters\_volumes\_put** > Volume datacenters\_volumes\_put(datacenter\_id, volume\_id, volume, pretty=pretty, depth=depth, x\_contract\_number=x\_contract\_number) Modify a Volume by ID Modifies the properties of the specified volume within the data center. #### Example ```python from __future__ import print_function import time import ionoscloud from ionoscloud.rest import ApiException # Defining the host is optional and defaults to https://api.ionos.com/cloudapi/v6 configuration = ionoscloud.Configuration( host = 'https://api.ionos.com/cloudapi/v6', ) # Example of configuring HTTP Basic Authorization configuration.username = 'YOUR_USERNAME' configuration.password = 'YOUR_PASSWORD' with ionoscloud.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = ionoscloud.VolumesApi(api_client) datacenter_id = 'datacenter_id_example' # str | The unique ID of the data center. volume_id = 'volume_id_example' # str | The unique ID of the volume. volume = ionoscloud.Volume() # Volume | The modified volume try: # Modify a Volume by ID api_response = api_instance.datacenters_volumes_put(datacenter_id, volume_id, volume) print(api_response) except ApiException as e: print('Exception when calling VolumesApi.datacenters_volumes_put: %s\n' % e) ``` #### Parameters | Name | Type | Description | Notes | | ----------------------- | ------------------------------------------------------------------------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------ | | **datacenter\_id** | **str** | The unique ID of the data center. | | | **volume\_id** | **str** | The unique ID of the volume. | | | **volume** | [**Volume**](https://docs.ionos.com/sections-test/python-sdk/cloud-api-python-sdk/models/volume) | The modified volume | | | **pretty** | **bool** | Controls whether the response is pretty-printed (with indentations and new lines). | \[optional] \[default to True] | | **depth** | **int** | 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] | | **x\_contract\_number** | **int** | Users with multiple contracts must provide the contract number, for which all API requests are to be executed. | \[optional] | #### Return type [**Volume**](https://docs.ionos.com/sections-test/python-sdk/cloud-api-python-sdk/models/volume) #### Authorization Basic Authentication, Token Authentication #### HTTP request headers * **Content-Type**: application/json * **Accept**: application/json ## **datacenters\_volumes\_restore\_snapshot\_post** > datacenters\_volumes\_restore\_snapshot\_post(datacenter\_id, volume\_id, pretty=pretty, depth=depth, x\_contract\_number=x\_contract\_number, snapshot\_id=snapshot\_id) Restore volume snapshots Restore a snapshot for the specified volume within the data center. A snapshot is an image of a volume, which can be used to restore this volume at a later time. #### Example ```python from __future__ import print_function import time import ionoscloud from ionoscloud.rest import ApiException # Defining the host is optional and defaults to https://api.ionos.com/cloudapi/v6 configuration = ionoscloud.Configuration( host = 'https://api.ionos.com/cloudapi/v6', ) # Example of configuring HTTP Basic Authorization configuration.username = 'YOUR_USERNAME' configuration.password = 'YOUR_PASSWORD' with ionoscloud.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = ionoscloud.VolumesApi(api_client) datacenter_id = 'datacenter_id_example' # str | The unique ID of the data center. volume_id = 'volume_id_example' # str | The unique ID of the volume. try: # Restore volume snapshots api_instance.datacenters_volumes_restore_snapshot_post(datacenter_id, volume_id) except ApiException as e: print('Exception when calling VolumesApi.datacenters_volumes_restore_snapshot_post: %s\n' % e) ``` #### Parameters | Name | Type | Description | Notes | | ----------------------- | -------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------ | | **datacenter\_id** | **str** | The unique ID of the data center. | | | **volume\_id** | **str** | The unique ID of the volume. | | | **pretty** | **bool** | Controls whether the response is pretty-printed (with indentations and new lines). | \[optional] \[default to True] | | **depth** | **int** | 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] | | **x\_contract\_number** | **int** | Users with multiple contracts must provide the contract number, for which all API requests are to be executed. | \[optional] | | **snapshot\_id** | **str** | The unique ID of the snapshot. | \[optional] | #### Return type void (empty response body) #### Authorization Basic Authentication, Token Authentication #### HTTP request headers * **Content-Type**: application/x-www-form-urlencoded * **Accept**: application/json