ionoscloud 5.0.0 → 6.0.0.beta.3

data/docs/Users.md

@@ -0,0 +1,24 @@
+# Users
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | The resource's unique identifier | [optional][readonly] |
+| **type** | [**Type**](Type.md) | The type of object that has been created | [optional] |
+| **href** | **String** | URL to the object representation (absolute path) | [optional][readonly] |
+| **items** | [**Array<User>**](User.md) | Array of items in that collection | [optional][readonly] |
+
+## Example
+
+```ruby
+require 'ionoscloud'
+
+instance = Ionoscloud::Users.new(
+  id: 15f67991-0f51-4efc-a8ad-ef1fb31a480c,
+  type: "collection",
+  href: <RESOURCE-URI>,
+  items: null
+)
+```
+

data/docs/UsersEntities.md

@@ -0,0 +1,20 @@
+# UsersEntities
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **owns** | [**ResourcesUsers**](ResourcesUsers.md) |  | [optional] |
+| **groups** | [**GroupUsers**](GroupUsers.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'ionoscloud'
+
+instance = Ionoscloud::UsersEntities.new(
+  owns: null,
+  groups: null
+)
+```
+

data/docs/Volume.md

@@ -0,0 +1,26 @@
+# Volume
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | The resource's unique identifier | [optional][readonly] |
+| **type** | [**Type**](Type.md) | The type of object that has been created | [optional] |
+| **href** | **String** | URL to the object representation (absolute path) | [optional][readonly] |
+| **metadata** | [**DatacenterElementMetadata**](DatacenterElementMetadata.md) |  | [optional] |
+| **properties** | [**VolumeProperties**](VolumeProperties.md) |  |  |
+
+## Example
+
+```ruby
+require 'ionoscloud'
+
+instance = Ionoscloud::Volume.new(
+  id: 15f67991-0f51-4efc-a8ad-ef1fb31a480c,
+  type: "volume",
+  href: <RESOURCE-URI>,
+  metadata: null,
+  properties: null
+)
+```
+

data/docs/VolumeProperties.md

@@ -0,0 +1,54 @@
+# VolumeProperties
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** | A name of that resource | [optional] |
+| **type** | **String** | Hardware type of the volume. DAS (Direct Attached Storage) could be used only in a composite call with a Cube server | [optional] |
+| **size** | **Float** | The size of the volume in GB |  |
+| **availability_zone** | **String** | The availability zone in which the volume should exist. The storage volume will be provisioned on as less physical storages as possible but cannot guarantee upfront. It is not available for DAS (Direct Attached Storage) and subject of availability for SSD. | [optional] |
+| **image** | **String** | Image or snapshot ID to be used as template for this volume | [optional] |
+| **image_password** | **String** | Initial password to be set for installed OS. Works with public images only. Not modifiable, forbidden in update requests. Password rules allows all characters from a-z, A-Z, 0-9 | [optional] |
+| **ssh_keys** | **Array<String>** | Public SSH keys are set on the image as authorized keys for appropriate SSH login to the instance using the corresponding private key. This field may only be set in creation requests. When reading, it always returns null. SSH keys are only supported if a public Linux image is used for the volume creation. | [optional] |
+| **bus** | **String** | The bus type of the volume. Default is VIRTIO | [optional] |
+| **licence_type** | **String** | OS type of this volume | [optional][readonly] |
+| **cpu_hot_plug** | **Boolean** | Is capable of CPU hot plug (no reboot required) | [optional] |
+| **ram_hot_plug** | **Boolean** | Is capable of memory hot plug (no reboot required) | [optional] |
+| **nic_hot_plug** | **Boolean** | Is capable of nic hot plug (no reboot required) | [optional] |
+| **nic_hot_unplug** | **Boolean** | Is capable of nic hot unplug (no reboot required) | [optional] |
+| **disc_virtio_hot_plug** | **Boolean** | Is capable of Virt-IO drive hot plug (no reboot required) | [optional] |
+| **disc_virtio_hot_unplug** | **Boolean** | Is capable of Virt-IO drive hot unplug (no reboot required). This works only for non-Windows virtual Machines. | [optional] |
+| **device_number** | **Integer** | The Logical Unit Number of the storage volume. Null for volumes not mounted to any VM | [optional][readonly] |
+| **pci_slot** | **Integer** | The PCI slot number of the storage volume. Null for volumes not mounted to any VM | [optional][readonly] |
+| **backupunit_id** | **String** | The uuid of the Backup Unit that user has access to. The property is immutable and is only allowed to be set on a new volume creation. It is mandatory to provide either 'public image' or 'imageAlias' in conjunction with this property. | [optional] |
+| **user_data** | **String** | The cloud-init configuration for the volume as base64 encoded string. The property is immutable and is only allowed to be set on a new volume creation. It is mandatory to provide either 'public image' or 'imageAlias' that has cloud-init compatibility in conjunction with this property. | [optional] |
+
+## Example
+
+```ruby
+require 'ionoscloud'
+
+instance = Ionoscloud::VolumeProperties.new(
+  name: My resource,
+  type: HDD,
+  size: 100.0,
+  availability_zone: AUTO,
+  image: d6ad1576-fde9-4696-aa41-1ebd75bdaf49,
+  image_password: mypass123,
+  ssh_keys: [ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQCyWh6LZ7f2wxnupVgtK2096bc69Vv9uT2A58lwN3ol0A6mxqlT0f4M1NbarVUxa+MVdxBLud5PvlkbYc9mY91OyzLGZMfVWvhAYz/tJSsDtsgRUl0GFVv332zDWk0i+mAVy0N408OORm5XqV6zvIDaiB/jopyjemUp2rnP7pXU4+98ilZw6ef9DF9y4YZ64mchL5//rcrGm1Lff3pC75X/polGONHeG6m4Vs8eIu+0epJ4PJBxO+rwRYp1zMnn90UCk21KvTcYops2cte7ouXQwkGUq3vmXxnSdvuivK/4JNoFQBsaGV974hDmloS5LOvSJjKpXs8Ed437ln712345, ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQCyWh6LZ7f2wxnupVgtK2096bc69Vv9uT2A58lwN3ol0A6mxqlT0f4M1NbarVUxa+MVdxBLud5PvlkbYc9mY91OyzLGZMfVWvhAYz/tJSsDtsgRUl0GFVv332zDWk0i+mAVy0N408OORm5XqV6zvIDaiB/jopyjemUp2rnP7pXU4+98ilZw6ef9DF9y4YZ64mchL5//rcrGm1Lff3pC75X/polGONHeG6m4Vs8eIu+0epJ4PJBxO+rwRYp1zMnn90UCk21KvTcYops2cte7ouXQwkGUq3vmXxnSdvuivK/asdfghjkjhyutry545tgvbn76e4rf43],
+  bus: VIRTIO,
+  licence_type: LINUX,
+  cpu_hot_plug: true,
+  ram_hot_plug: true,
+  nic_hot_plug: true,
+  nic_hot_unplug: true,
+  disc_virtio_hot_plug: true,
+  disc_virtio_hot_unplug: true,
+  device_number: 3,
+  pci_slot: 7,
+  backupunit_id: 25f67991-0f51-4efc-a8ad-ef1fb31a481c,
+  user_data: null
+)
+```
+

data/docs/Volumes.md

@@ -0,0 +1,30 @@
+# Volumes
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | The resource's unique identifier | [optional][readonly] |
+| **type** | [**Type**](Type.md) | The type of object that has been created | [optional] |
+| **href** | **String** | URL to the object representation (absolute path) | [optional][readonly] |
+| **items** | [**Array<Volume>**](Volume.md) | Array of items in that collection | [optional][readonly] |
+| **offset** | **Float** | the offset (if specified in the request) | [optional] |
+| **limit** | **Float** | the limit (if specified in the request) | [optional] |
+| **_links** | [**PaginationLinks**](PaginationLinks.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'ionoscloud'
+
+instance = Ionoscloud::Volumes.new(
+  id: 15f67991-0f51-4efc-a8ad-ef1fb31a480c,
+  type: "collection",
+  href: <RESOURCE-URI>,
+  items: null,
+  offset: 0,
+  limit: 1000,
+  _links: null
+)
+```
+

data/docs/VolumesApi.md

@@ -0,0 +1,709 @@
+# VolumesApi
+
+All URIs are relative to *https://api.ionos.com/cloudapi/v6*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**datacenters_volumes_create_snapshot_post**](VolumesApi.md#datacenters_volumes_create_snapshot_post) | **POST** /datacenters/{datacenterId}/volumes/{volumeId}/create-snapshot | Create Volume Snapshot |
+| [**datacenters_volumes_delete**](VolumesApi.md#datacenters_volumes_delete) | **DELETE** /datacenters/{datacenterId}/volumes/{volumeId} | Delete a Volume |
+| [**datacenters_volumes_find_by_id**](VolumesApi.md#datacenters_volumes_find_by_id) | **GET** /datacenters/{datacenterId}/volumes/{volumeId} | Retrieve a Volume |
+| [**datacenters_volumes_get**](VolumesApi.md#datacenters_volumes_get) | **GET** /datacenters/{datacenterId}/volumes | List Volumes |
+| [**datacenters_volumes_patch**](VolumesApi.md#datacenters_volumes_patch) | **PATCH** /datacenters/{datacenterId}/volumes/{volumeId} | Partially modify a Volume |
+| [**datacenters_volumes_post**](VolumesApi.md#datacenters_volumes_post) | **POST** /datacenters/{datacenterId}/volumes | Create a Volume |
+| [**datacenters_volumes_put**](VolumesApi.md#datacenters_volumes_put) | **PUT** /datacenters/{datacenterId}/volumes/{volumeId} | Modify a Volume |
+| [**datacenters_volumes_restore_snapshot_post**](VolumesApi.md#datacenters_volumes_restore_snapshot_post) | **POST** /datacenters/{datacenterId}/volumes/{volumeId}/restore-snapshot | Restore Volume Snapshot |
+
+
+## datacenters_volumes_create_snapshot_post
+
+> <Snapshot> datacenters_volumes_create_snapshot_post(datacenter_id, volume_id, opts)
+
+Create Volume Snapshot
+
+Creates a snapshot of a volume within the datacenter. You can use a snapshot to create a new storage volume or to restore a storage volume.
+
+### Examples
+
+```ruby
+require 'time'
+require 'ionoscloud'
+# setup authorization
+Ionoscloud.configure do |config|
+  # Configure HTTP basic authorization: Basic Authentication
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+
+  # Configure API key authorization: Token Authentication
+  config.api_key['Authorization'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['Authorization'] = 'Bearer'
+end
+
+api_instance = Ionoscloud::VolumesApi.new
+datacenter_id = 'datacenter_id_example' # String | The unique ID of the datacenter
+volume_id = 'volume_id_example' # String | The unique ID of the Volume
+opts = {
+  pretty: true, # Boolean | Controls whether response is pretty-printed (with indentation and new lines)
+  depth: 56, # 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
+  x_contract_number: 56, # Integer | Users having more than 1 contract need to provide contract number, against which all API requests should be executed
+  name: 'name_example', # String | The name of the snapshot
+  description: 'description_example', # String | The description of the snapshot
+  sec_auth_protection: true, # Boolean | Flag representing if extra protection is enabled on snapshot e.g. Two Factor protection etc.
+  licence_type: 'UNKNOWN' # String | The OS type of this Snapshot
+}
+
+begin
+  # Create Volume Snapshot
+  result = api_instance.datacenters_volumes_create_snapshot_post(datacenter_id, volume_id, opts)
+  p result
+rescue Ionoscloud::ApiError => e
+  puts "Error when calling VolumesApi->datacenters_volumes_create_snapshot_post: #{e}"
+end
+```
+
+#### Using the datacenters_volumes_create_snapshot_post_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Snapshot>, Integer, Hash)> datacenters_volumes_create_snapshot_post_with_http_info(datacenter_id, volume_id, opts)
+
+```ruby
+begin
+  # Create Volume Snapshot
+  data, status_code, headers = api_instance.datacenters_volumes_create_snapshot_post_with_http_info(datacenter_id, volume_id, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Snapshot>
+rescue Ionoscloud::ApiError => e
+  puts "Error when calling VolumesApi->datacenters_volumes_create_snapshot_post_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **datacenter_id** | **String** | The unique ID of the datacenter |  |
+| **volume_id** | **String** | The unique ID of the Volume |  |
+| **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&#x3D;0: only direct properties are included. Children (servers etc.) are not included  - depth&#x3D;1: direct properties and children references are included  - depth&#x3D;2: direct properties and children properties are included  - depth&#x3D;3: direct properties and children properties and children&#39;s children are included  - depth&#x3D;... 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] |
+| **name** | **String** | The name of the snapshot | [optional] |
+| **description** | **String** | The description of the snapshot | [optional] |
+| **sec_auth_protection** | **Boolean** | Flag representing if extra protection is enabled on snapshot e.g. Two Factor protection etc. | [optional] |
+| **licence_type** | **String** | The OS type of this Snapshot | [optional] |
+
+### Return type
+
+[**Snapshot**](Snapshot.md)
+
+### 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, opts)
+
+Delete a Volume
+
+Deletes the specified volume. This will result in the volume being removed from your datacenter. Use this with caution.
+
+### Examples
+
+```ruby
+require 'time'
+require 'ionoscloud'
+# setup authorization
+Ionoscloud.configure do |config|
+  # Configure HTTP basic authorization: Basic Authentication
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+
+  # Configure API key authorization: Token Authentication
+  config.api_key['Authorization'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['Authorization'] = 'Bearer'
+end
+
+api_instance = Ionoscloud::VolumesApi.new
+datacenter_id = 'datacenter_id_example' # String | The unique ID of the datacenter
+volume_id = 'volume_id_example' # String | The unique ID of the Volume
+opts = {
+  pretty: true, # Boolean | Controls whether response is pretty-printed (with indentation and new lines)
+  depth: 56, # 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
+  x_contract_number: 56 # Integer | Users having more than 1 contract need to provide contract number, against which all API requests should be executed
+}
+
+begin
+  # Delete a Volume
+  api_instance.datacenters_volumes_delete(datacenter_id, volume_id, opts)
+rescue Ionoscloud::ApiError => e
+  puts "Error when calling VolumesApi->datacenters_volumes_delete: #{e}"
+end
+```
+
+#### Using the datacenters_volumes_delete_with_http_info variant
+
+This returns an Array which contains the response data (`nil` in this case), status code and headers.
+
+> <Array(nil, Integer, Hash)> datacenters_volumes_delete_with_http_info(datacenter_id, volume_id, opts)
+
+```ruby
+begin
+  # Delete a Volume
+  data, status_code, headers = api_instance.datacenters_volumes_delete_with_http_info(datacenter_id, volume_id, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => nil
+rescue Ionoscloud::ApiError => e
+  puts "Error when calling VolumesApi->datacenters_volumes_delete_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **datacenter_id** | **String** | The unique ID of the datacenter |  |
+| **volume_id** | **String** | The unique ID of the Volume |  |
+| **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&#x3D;0: only direct properties are included. Children (servers etc.) are not included  - depth&#x3D;1: direct properties and children references are included  - depth&#x3D;2: direct properties and children properties are included  - depth&#x3D;3: direct properties and children properties and children&#39;s children are included  - depth&#x3D;... 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
+
+nil (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, opts)
+
+Retrieve a Volume
+
+Retrieves the attributes of a given Volume
+
+### Examples
+
+```ruby
+require 'time'
+require 'ionoscloud'
+# setup authorization
+Ionoscloud.configure do |config|
+  # Configure HTTP basic authorization: Basic Authentication
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+
+  # Configure API key authorization: Token Authentication
+  config.api_key['Authorization'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['Authorization'] = 'Bearer'
+end
+
+api_instance = Ionoscloud::VolumesApi.new
+datacenter_id = 'datacenter_id_example' # String | The unique ID of the datacenter
+volume_id = 'volume_id_example' # String | The unique ID of the Volume
+opts = {
+  pretty: true, # Boolean | Controls whether response is pretty-printed (with indentation and new lines)
+  depth: 56, # 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
+  x_contract_number: 56 # Integer | Users having more than 1 contract need to provide contract number, against which all API requests should be executed
+}
+
+begin
+  # Retrieve a Volume
+  result = api_instance.datacenters_volumes_find_by_id(datacenter_id, volume_id, opts)
+  p result
+rescue Ionoscloud::ApiError => e
+  puts "Error when calling VolumesApi->datacenters_volumes_find_by_id: #{e}"
+end
+```
+
+#### Using the datacenters_volumes_find_by_id_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Volume>, Integer, Hash)> datacenters_volumes_find_by_id_with_http_info(datacenter_id, volume_id, opts)
+
+```ruby
+begin
+  # Retrieve a Volume
+  data, status_code, headers = api_instance.datacenters_volumes_find_by_id_with_http_info(datacenter_id, volume_id, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Volume>
+rescue Ionoscloud::ApiError => e
+  puts "Error when calling VolumesApi->datacenters_volumes_find_by_id_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **datacenter_id** | **String** | The unique ID of the datacenter |  |
+| **volume_id** | **String** | The unique ID of the Volume |  |
+| **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&#x3D;0: only direct properties are included. Children (servers etc.) are not included  - depth&#x3D;1: direct properties and children references are included  - depth&#x3D;2: direct properties and children properties are included  - depth&#x3D;3: direct properties and children properties and children&#39;s children are included  - depth&#x3D;... 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
+
+[**Volume**](Volume.md)
+
+### Authorization
+
+Basic Authentication, Token Authentication
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## datacenters_volumes_get
+
+> <Volumes> datacenters_volumes_get(datacenter_id, opts)
+
+List Volumes
+
+Retrieves a list of Volumes.
+
+### Examples
+
+```ruby
+require 'time'
+require 'ionoscloud'
+# setup authorization
+Ionoscloud.configure do |config|
+  # Configure HTTP basic authorization: Basic Authentication
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+
+  # Configure API key authorization: Token Authentication
+  config.api_key['Authorization'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['Authorization'] = 'Bearer'
+end
+
+api_instance = Ionoscloud::VolumesApi.new
+datacenter_id = 'datacenter_id_example' # String | The unique ID of the datacenter
+opts = {
+  pretty: true, # Boolean | Controls whether response is pretty-printed (with indentation and new lines)
+  depth: 56, # 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
+  x_contract_number: 56, # Integer | Users having more than 1 contract need to provide contract number, against which all API requests should be executed
+  offset: 56, # Integer | the first element (of the total list of elements) to include in the response (use together with limit for pagination)
+  limit: 56 # Integer | the maximum number of elements to return (use together with offset for pagination)
+}
+
+begin
+  # List Volumes
+  result = api_instance.datacenters_volumes_get(datacenter_id, opts)
+  p result
+rescue Ionoscloud::ApiError => e
+  puts "Error when calling VolumesApi->datacenters_volumes_get: #{e}"
+end
+```
+
+#### Using the datacenters_volumes_get_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Volumes>, Integer, Hash)> datacenters_volumes_get_with_http_info(datacenter_id, opts)
+
+```ruby
+begin
+  # List Volumes
+  data, status_code, headers = api_instance.datacenters_volumes_get_with_http_info(datacenter_id, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Volumes>
+rescue Ionoscloud::ApiError => e
+  puts "Error when calling VolumesApi->datacenters_volumes_get_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **datacenter_id** | **String** | The unique ID of the datacenter |  |
+| **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&#x3D;0: only direct properties are included. Children (servers etc.) are not included  - depth&#x3D;1: direct properties and children references are included  - depth&#x3D;2: direct properties and children properties are included  - depth&#x3D;3: direct properties and children properties and children&#39;s children are included  - depth&#x3D;... 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] |
+| **offset** | **Integer** | the first element (of the total list of elements) to include in the response (use together with limit for pagination) | [optional][default to 0] |
+| **limit** | **Integer** | the maximum number of elements to return (use together with offset for pagination) | [optional][default to 1000] |
+
+### Return type
+
+[**Volumes**](Volumes.md)
+
+### 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, opts)
+
+Partially modify a Volume
+
+You can use update attributes of a volume.
+
+### Examples
+
+```ruby
+require 'time'
+require 'ionoscloud'
+# setup authorization
+Ionoscloud.configure do |config|
+  # Configure HTTP basic authorization: Basic Authentication
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+
+  # Configure API key authorization: Token Authentication
+  config.api_key['Authorization'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['Authorization'] = 'Bearer'
+end
+
+api_instance = Ionoscloud::VolumesApi.new
+datacenter_id = 'datacenter_id_example' # String | The unique ID of the datacenter
+volume_id = 'volume_id_example' # String | The unique ID of the Volume
+volume = Ionoscloud::VolumeProperties.new({size: 100.0}) # VolumeProperties | Modified properties of Volume
+opts = {
+  pretty: true, # Boolean | Controls whether response is pretty-printed (with indentation and new lines)
+  depth: 56, # 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
+  x_contract_number: 56 # Integer | Users having more than 1 contract need to provide contract number, against which all API requests should be executed
+}
+
+begin
+  # Partially modify a Volume
+  result = api_instance.datacenters_volumes_patch(datacenter_id, volume_id, volume, opts)
+  p result
+rescue Ionoscloud::ApiError => e
+  puts "Error when calling VolumesApi->datacenters_volumes_patch: #{e}"
+end
+```
+
+#### Using the datacenters_volumes_patch_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Volume>, Integer, Hash)> datacenters_volumes_patch_with_http_info(datacenter_id, volume_id, volume, opts)
+
+```ruby
+begin
+  # Partially modify a Volume
+  data, status_code, headers = api_instance.datacenters_volumes_patch_with_http_info(datacenter_id, volume_id, volume, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Volume>
+rescue Ionoscloud::ApiError => e
+  puts "Error when calling VolumesApi->datacenters_volumes_patch_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **datacenter_id** | **String** | The unique ID of the datacenter |  |
+| **volume_id** | **String** | The unique ID of the Volume |  |
+| **volume** | [**VolumeProperties**](VolumeProperties.md) | Modified properties of Volume |  |
+| **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&#x3D;0: only direct properties are included. Children (servers etc.) are not included  - depth&#x3D;1: direct properties and children references are included  - depth&#x3D;2: direct properties and children properties are included  - depth&#x3D;3: direct properties and children properties and children&#39;s children are included  - depth&#x3D;... 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
+
+[**Volume**](Volume.md)
+
+### 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, opts)
+
+Create a Volume
+
+Creates a volume within the datacenter. This will not attach the volume to a server. Please see the Servers section for details on how to attach storage volumes
+
+### Examples
+
+```ruby
+require 'time'
+require 'ionoscloud'
+# setup authorization
+Ionoscloud.configure do |config|
+  # Configure HTTP basic authorization: Basic Authentication
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+
+  # Configure API key authorization: Token Authentication
+  config.api_key['Authorization'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['Authorization'] = 'Bearer'
+end
+
+api_instance = Ionoscloud::VolumesApi.new
+datacenter_id = 'datacenter_id_example' # String | The unique ID of the datacenter
+volume = Ionoscloud::Volume.new({properties: Ionoscloud::VolumeProperties.new({size: 100.0})}) # Volume | Volume to be created
+opts = {
+  pretty: true, # Boolean | Controls whether response is pretty-printed (with indentation and new lines)
+  depth: 56, # 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
+  x_contract_number: 56 # Integer | Users having more than 1 contract need to provide contract number, against which all API requests should be executed
+}
+
+begin
+  # Create a Volume
+  result = api_instance.datacenters_volumes_post(datacenter_id, volume, opts)
+  p result
+rescue Ionoscloud::ApiError => e
+  puts "Error when calling VolumesApi->datacenters_volumes_post: #{e}"
+end
+```
+
+#### Using the datacenters_volumes_post_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Volume>, Integer, Hash)> datacenters_volumes_post_with_http_info(datacenter_id, volume, opts)
+
+```ruby
+begin
+  # Create a Volume
+  data, status_code, headers = api_instance.datacenters_volumes_post_with_http_info(datacenter_id, volume, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Volume>
+rescue Ionoscloud::ApiError => e
+  puts "Error when calling VolumesApi->datacenters_volumes_post_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **datacenter_id** | **String** | The unique ID of the datacenter |  |
+| **volume** | [**Volume**](Volume.md) | Volume to be created |  |
+| **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&#x3D;0: only direct properties are included. Children (servers etc.) are not included  - depth&#x3D;1: direct properties and children references are included  - depth&#x3D;2: direct properties and children properties are included  - depth&#x3D;3: direct properties and children properties and children&#39;s children are included  - depth&#x3D;... 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
+
+[**Volume**](Volume.md)
+
+### 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, opts)
+
+Modify a Volume
+
+You can use update attributes of a Volume
+
+### Examples
+
+```ruby
+require 'time'
+require 'ionoscloud'
+# setup authorization
+Ionoscloud.configure do |config|
+  # Configure HTTP basic authorization: Basic Authentication
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+
+  # Configure API key authorization: Token Authentication
+  config.api_key['Authorization'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['Authorization'] = 'Bearer'
+end
+
+api_instance = Ionoscloud::VolumesApi.new
+datacenter_id = 'datacenter_id_example' # String | The unique ID of the datacenter
+volume_id = 'volume_id_example' # String | The unique ID of the Volume
+volume = Ionoscloud::Volume.new({properties: Ionoscloud::VolumeProperties.new({size: 100.0})}) # Volume | Modified Volume
+opts = {
+  pretty: true, # Boolean | Controls whether response is pretty-printed (with indentation and new lines)
+  depth: 56, # 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
+  x_contract_number: 56 # Integer | Users having more than 1 contract need to provide contract number, against which all API requests should be executed
+}
+
+begin
+  # Modify a Volume
+  result = api_instance.datacenters_volumes_put(datacenter_id, volume_id, volume, opts)
+  p result
+rescue Ionoscloud::ApiError => e
+  puts "Error when calling VolumesApi->datacenters_volumes_put: #{e}"
+end
+```
+
+#### Using the datacenters_volumes_put_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Volume>, Integer, Hash)> datacenters_volumes_put_with_http_info(datacenter_id, volume_id, volume, opts)
+
+```ruby
+begin
+  # Modify a Volume
+  data, status_code, headers = api_instance.datacenters_volumes_put_with_http_info(datacenter_id, volume_id, volume, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Volume>
+rescue Ionoscloud::ApiError => e
+  puts "Error when calling VolumesApi->datacenters_volumes_put_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **datacenter_id** | **String** | The unique ID of the datacenter |  |
+| **volume_id** | **String** | The unique ID of the Volume |  |
+| **volume** | [**Volume**](Volume.md) | Modified Volume |  |
+| **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&#x3D;0: only direct properties are included. Children (servers etc.) are not included  - depth&#x3D;1: direct properties and children references are included  - depth&#x3D;2: direct properties and children properties are included  - depth&#x3D;3: direct properties and children properties and children&#39;s children are included  - depth&#x3D;... 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
+
+[**Volume**](Volume.md)
+
+### 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, opts)
+
+Restore Volume Snapshot
+
+This will restore a snapshot onto a volume. A snapshot is created as just another image that can be used to create subsequent volumes if you want or to restore an existing volume.
+
+### Examples
+
+```ruby
+require 'time'
+require 'ionoscloud'
+# setup authorization
+Ionoscloud.configure do |config|
+  # Configure HTTP basic authorization: Basic Authentication
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+
+  # Configure API key authorization: Token Authentication
+  config.api_key['Authorization'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['Authorization'] = 'Bearer'
+end
+
+api_instance = Ionoscloud::VolumesApi.new
+datacenter_id = 'datacenter_id_example' # String | The unique ID of the datacenter
+volume_id = 'volume_id_example' # String | The unique ID of the Volume
+opts = {
+  pretty: true, # Boolean | Controls whether response is pretty-printed (with indentation and new lines)
+  depth: 56, # 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
+  x_contract_number: 56, # Integer | Users having more than 1 contract need to provide contract number, against which all API requests should be executed
+  snapshot_id: 'snapshot_id_example' # String | This is the ID of the snapshot
+}
+
+begin
+  # Restore Volume Snapshot
+  api_instance.datacenters_volumes_restore_snapshot_post(datacenter_id, volume_id, opts)
+rescue Ionoscloud::ApiError => e
+  puts "Error when calling VolumesApi->datacenters_volumes_restore_snapshot_post: #{e}"
+end
+```
+
+#### Using the datacenters_volumes_restore_snapshot_post_with_http_info variant
+
+This returns an Array which contains the response data (`nil` in this case), status code and headers.
+
+> <Array(nil, Integer, Hash)> datacenters_volumes_restore_snapshot_post_with_http_info(datacenter_id, volume_id, opts)
+
+```ruby
+begin
+  # Restore Volume Snapshot
+  data, status_code, headers = api_instance.datacenters_volumes_restore_snapshot_post_with_http_info(datacenter_id, volume_id, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => nil
+rescue Ionoscloud::ApiError => e
+  puts "Error when calling VolumesApi->datacenters_volumes_restore_snapshot_post_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **datacenter_id** | **String** | The unique ID of the datacenter |  |
+| **volume_id** | **String** | The unique ID of the Volume |  |
+| **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&#x3D;0: only direct properties are included. Children (servers etc.) are not included  - depth&#x3D;1: direct properties and children references are included  - depth&#x3D;2: direct properties and children properties are included  - depth&#x3D;3: direct properties and children properties and children&#39;s children are included  - depth&#x3D;... 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] |
+| **snapshot_id** | **String** | This is the ID of the snapshot | [optional] |
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+Basic Authentication, Token Authentication
+
+### HTTP request headers
+
+- **Content-Type**: application/x-www-form-urlencoded
+- **Accept**: application/json
+