docs/api/ServersApi.md in ionoscloud-6.0.0.beta.4 vs docs/api/ServersApi.md in ionoscloud-6.0.0

- old
+ new

@@ -2,41 +2,41 @@ All URIs are relative to *https://api.ionos.com/cloudapi/v6* | Method | HTTP request | Description | | ------ | ------------ | ----------- | -| [**datacenters_servers_cdroms_delete**](ServersApi.md#datacenters_servers_cdroms_delete) | **DELETE** /datacenters/{datacenterId}/servers/{serverId}/cdroms/{cdromId} | Detach a CD-ROM | -| [**datacenters_servers_cdroms_find_by_id**](ServersApi.md#datacenters_servers_cdroms_find_by_id) | **GET** /datacenters/{datacenterId}/servers/{serverId}/cdroms/{cdromId} | Retrieve an attached CD-ROM | +| [**datacenters_servers_cdroms_delete**](ServersApi.md#datacenters_servers_cdroms_delete) | **DELETE** /datacenters/{datacenterId}/servers/{serverId}/cdroms/{cdromId} | Detach CD-ROMs | +| [**datacenters_servers_cdroms_find_by_id**](ServersApi.md#datacenters_servers_cdroms_find_by_id) | **GET** /datacenters/{datacenterId}/servers/{serverId}/cdroms/{cdromId} | Retrieve attached CD-ROMs | | [**datacenters_servers_cdroms_get**](ServersApi.md#datacenters_servers_cdroms_get) | **GET** /datacenters/{datacenterId}/servers/{serverId}/cdroms | List attached CD-ROMs | -| [**datacenters_servers_cdroms_post**](ServersApi.md#datacenters_servers_cdroms_post) | **POST** /datacenters/{datacenterId}/servers/{serverId}/cdroms | Attach a CD-ROM | -| [**datacenters_servers_delete**](ServersApi.md#datacenters_servers_delete) | **DELETE** /datacenters/{datacenterId}/servers/{serverId} | Delete a Server | -| [**datacenters_servers_find_by_id**](ServersApi.md#datacenters_servers_find_by_id) | **GET** /datacenters/{datacenterId}/servers/{serverId} | Retrieve a Server | -| [**datacenters_servers_get**](ServersApi.md#datacenters_servers_get) | **GET** /datacenters/{datacenterId}/servers | List Servers | -| [**datacenters_servers_patch**](ServersApi.md#datacenters_servers_patch) | **PATCH** /datacenters/{datacenterId}/servers/{serverId} | Partially modify a Server | -| [**datacenters_servers_post**](ServersApi.md#datacenters_servers_post) | **POST** /datacenters/{datacenterId}/servers | Create a Server | -| [**datacenters_servers_put**](ServersApi.md#datacenters_servers_put) | **PUT** /datacenters/{datacenterId}/servers/{serverId} | Modify a Server | -| [**datacenters_servers_reboot_post**](ServersApi.md#datacenters_servers_reboot_post) | **POST** /datacenters/{datacenterId}/servers/{serverId}/reboot | Reboot a Server | -| [**datacenters_servers_remote_console_get**](ServersApi.md#datacenters_servers_remote_console_get) | **GET** /datacenters/{datacenterId}/servers/{serverId}/remoteconsole | Get the server remote console link | -| [**datacenters_servers_resume_post**](ServersApi.md#datacenters_servers_resume_post) | **POST** /datacenters/{datacenterId}/servers/{serverId}/resume | Resume a Cube Server | -| [**datacenters_servers_start_post**](ServersApi.md#datacenters_servers_start_post) | **POST** /datacenters/{datacenterId}/servers/{serverId}/start | Start a Server | -| [**datacenters_servers_stop_post**](ServersApi.md#datacenters_servers_stop_post) | **POST** /datacenters/{datacenterId}/servers/{serverId}/stop | Stop a Server | -| [**datacenters_servers_suspend_post**](ServersApi.md#datacenters_servers_suspend_post) | **POST** /datacenters/{datacenterId}/servers/{serverId}/suspend | Suspend a Cube Server | -| [**datacenters_servers_token_get**](ServersApi.md#datacenters_servers_token_get) | **GET** /datacenters/{datacenterId}/servers/{serverId}/token | Get the server&#39;s jwToken | -| [**datacenters_servers_upgrade_post**](ServersApi.md#datacenters_servers_upgrade_post) | **POST** /datacenters/{datacenterId}/servers/{serverId}/upgrade | Upgrade a Server | -| [**datacenters_servers_volumes_delete**](ServersApi.md#datacenters_servers_volumes_delete) | **DELETE** /datacenters/{datacenterId}/servers/{serverId}/volumes/{volumeId} | Detach a volume | -| [**datacenters_servers_volumes_find_by_id**](ServersApi.md#datacenters_servers_volumes_find_by_id) | **GET** /datacenters/{datacenterId}/servers/{serverId}/volumes/{volumeId} | Retrieve an attached volume | -| [**datacenters_servers_volumes_get**](ServersApi.md#datacenters_servers_volumes_get) | **GET** /datacenters/{datacenterId}/servers/{serverId}/volumes | List Attached Volumes | -| [**datacenters_servers_volumes_post**](ServersApi.md#datacenters_servers_volumes_post) | **POST** /datacenters/{datacenterId}/servers/{serverId}/volumes | Attach a volume | +| [**datacenters_servers_cdroms_post**](ServersApi.md#datacenters_servers_cdroms_post) | **POST** /datacenters/{datacenterId}/servers/{serverId}/cdroms | Attach CD-ROMs | +| [**datacenters_servers_delete**](ServersApi.md#datacenters_servers_delete) | **DELETE** /datacenters/{datacenterId}/servers/{serverId} | Delete servers | +| [**datacenters_servers_find_by_id**](ServersApi.md#datacenters_servers_find_by_id) | **GET** /datacenters/{datacenterId}/servers/{serverId} | Retrieve servers by ID | +| [**datacenters_servers_get**](ServersApi.md#datacenters_servers_get) | **GET** /datacenters/{datacenterId}/servers | List servers | +| [**datacenters_servers_patch**](ServersApi.md#datacenters_servers_patch) | **PATCH** /datacenters/{datacenterId}/servers/{serverId} | Partially modify servers | +| [**datacenters_servers_post**](ServersApi.md#datacenters_servers_post) | **POST** /datacenters/{datacenterId}/servers | Create servers | +| [**datacenters_servers_put**](ServersApi.md#datacenters_servers_put) | **PUT** /datacenters/{datacenterId}/servers/{serverId} | Modify servers | +| [**datacenters_servers_reboot_post**](ServersApi.md#datacenters_servers_reboot_post) | **POST** /datacenters/{datacenterId}/servers/{serverId}/reboot | Reboot servers | +| [**datacenters_servers_remote_console_get**](ServersApi.md#datacenters_servers_remote_console_get) | **GET** /datacenters/{datacenterId}/servers/{serverId}/remoteconsole | Get Remote Console link | +| [**datacenters_servers_resume_post**](ServersApi.md#datacenters_servers_resume_post) | **POST** /datacenters/{datacenterId}/servers/{serverId}/resume | Resume Cubes instances | +| [**datacenters_servers_start_post**](ServersApi.md#datacenters_servers_start_post) | **POST** /datacenters/{datacenterId}/servers/{serverId}/start | Start servers | +| [**datacenters_servers_stop_post**](ServersApi.md#datacenters_servers_stop_post) | **POST** /datacenters/{datacenterId}/servers/{serverId}/stop | Stop VMs | +| [**datacenters_servers_suspend_post**](ServersApi.md#datacenters_servers_suspend_post) | **POST** /datacenters/{datacenterId}/servers/{serverId}/suspend | Suspend Cubes instances | +| [**datacenters_servers_token_get**](ServersApi.md#datacenters_servers_token_get) | **GET** /datacenters/{datacenterId}/servers/{serverId}/token | Get JASON Web Token | +| [**datacenters_servers_upgrade_post**](ServersApi.md#datacenters_servers_upgrade_post) | **POST** /datacenters/{datacenterId}/servers/{serverId}/upgrade | Upgrade servers | +| [**datacenters_servers_volumes_delete**](ServersApi.md#datacenters_servers_volumes_delete) | **DELETE** /datacenters/{datacenterId}/servers/{serverId}/volumes/{volumeId} | Detach volumes | +| [**datacenters_servers_volumes_find_by_id**](ServersApi.md#datacenters_servers_volumes_find_by_id) | **GET** /datacenters/{datacenterId}/servers/{serverId}/volumes/{volumeId} | Retrieve attached volumes | +| [**datacenters_servers_volumes_get**](ServersApi.md#datacenters_servers_volumes_get) | **GET** /datacenters/{datacenterId}/servers/{serverId}/volumes | List attached volumes | +| [**datacenters_servers_volumes_post**](ServersApi.md#datacenters_servers_volumes_post) | **POST** /datacenters/{datacenterId}/servers/{serverId}/volumes | Attach volumes | ## datacenters_servers_cdroms_delete > datacenters_servers_cdroms_delete(datacenter_id, server_id, cdrom_id, opts) -Detach a CD-ROM +Detach CD-ROMs -This will detach a CD-ROM from the server +Detach the specified CD-ROM from the server. ### Examples ```ruby require 'time' @@ -53,20 +53,20 @@ # config.api_key_prefix['Authorization'] = 'Bearer' end api_instance = Ionoscloud::ServersApi.new datacenter_id = 'datacenter_id_example' # String | The unique ID of the data center. -server_id = 'server_id_example' # String | The unique ID of the Server -cdrom_id = 'cdrom_id_example' # String | The unique ID of the CD-ROM +server_id = 'server_id_example' # String | The unique ID of the server. +cdrom_id = 'cdrom_id_example' # String | The unique ID of the CD-ROM. opts = { pretty: true, # Boolean | Controls whether the response is pretty-printed (with indentations and new lines). depth: 56, # 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 x_contract_number: 56 # Integer | Users with multiple contracts must provide the contract number, against which all API requests are to be executed. } begin - # Detach a CD-ROM + # Detach CD-ROMs api_instance.datacenters_servers_cdroms_delete(datacenter_id, server_id, cdrom_id, opts) rescue Ionoscloud::ApiError => e puts "Error when calling ServersApi->datacenters_servers_cdroms_delete: #{e}" end ``` @@ -77,11 +77,11 @@ > <Array(nil, Integer, Hash)> datacenters_servers_cdroms_delete_with_http_info(datacenter_id, server_id, cdrom_id, opts) ```ruby begin - # Detach a CD-ROM + # Detach CD-ROMs data, status_code, headers = api_instance.datacenters_servers_cdroms_delete_with_http_info(datacenter_id, server_id, cdrom_id, opts) p status_code # => 2xx p headers # => { ... } p data # => nil rescue Ionoscloud::ApiError => e @@ -92,12 +92,12 @@ ### Parameters | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | | **datacenter_id** | **String** | The unique ID of the data center. | | -| **server_id** | **String** | The unique ID of the Server | | -| **cdrom_id** | **String** | The unique ID of the CD-ROM | | +| **server_id** | **String** | The unique ID of the server. | | +| **cdrom_id** | **String** | The unique ID of the CD-ROM. | | | **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&#x3D;0: Only direct properties are included; children (servers and other elements) 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 with multiple contracts must provide the contract number, against which all API requests are to be executed. | [optional] | ### Return type @@ -116,13 +116,13 @@ ## datacenters_servers_cdroms_find_by_id > <Image> datacenters_servers_cdroms_find_by_id(datacenter_id, server_id, cdrom_id, opts) -Retrieve an attached CD-ROM +Retrieve attached CD-ROMs -You can retrieve a specific CD-ROM attached to the server +Retrieve the properties of the CD-ROM, attached to the specified server. ### Examples ```ruby require 'time' @@ -139,20 +139,20 @@ # config.api_key_prefix['Authorization'] = 'Bearer' end api_instance = Ionoscloud::ServersApi.new datacenter_id = 'datacenter_id_example' # String | The unique ID of the data center. -server_id = 'server_id_example' # String | The unique ID of the Server -cdrom_id = 'cdrom_id_example' # String | The unique ID of the CD-ROM +server_id = 'server_id_example' # String | The unique ID of the server. +cdrom_id = 'cdrom_id_example' # String | The unique ID of the CD-ROM. opts = { pretty: true, # Boolean | Controls whether the response is pretty-printed (with indentations and new lines). depth: 56, # 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 x_contract_number: 56 # Integer | Users with multiple contracts must provide the contract number, against which all API requests are to be executed. } begin - # Retrieve an attached CD-ROM + # Retrieve attached CD-ROMs result = api_instance.datacenters_servers_cdroms_find_by_id(datacenter_id, server_id, cdrom_id, opts) p result rescue Ionoscloud::ApiError => e puts "Error when calling ServersApi->datacenters_servers_cdroms_find_by_id: #{e}" end @@ -164,11 +164,11 @@ > <Array(<Image>, Integer, Hash)> datacenters_servers_cdroms_find_by_id_with_http_info(datacenter_id, server_id, cdrom_id, opts) ```ruby begin - # Retrieve an attached CD-ROM + # Retrieve attached CD-ROMs data, status_code, headers = api_instance.datacenters_servers_cdroms_find_by_id_with_http_info(datacenter_id, server_id, cdrom_id, opts) p status_code # => 2xx p headers # => { ... } p data # => <Image> rescue Ionoscloud::ApiError => e @@ -179,19 +179,19 @@ ### Parameters | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | | **datacenter_id** | **String** | The unique ID of the data center. | | -| **server_id** | **String** | The unique ID of the Server | | -| **cdrom_id** | **String** | The unique ID of the CD-ROM | | +| **server_id** | **String** | The unique ID of the server. | | +| **cdrom_id** | **String** | The unique ID of the CD-ROM. | | | **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&#x3D;0: Only direct properties are included; children (servers and other elements) 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 with multiple contracts must provide the contract number, against which all API requests are to be executed. | [optional] | ### Return type -[**Image**](Image.md) +[**Image**](../models/Image.md) ### Authorization Basic Authentication, Token Authentication @@ -205,11 +205,11 @@ > <Cdroms> datacenters_servers_cdroms_get(datacenter_id, server_id, opts) List attached CD-ROMs -You can retrieve a list of CD-ROMs attached to the server. +List all CD-ROMs, attached to the specified server. ### Examples ```ruby require 'time' @@ -226,11 +226,11 @@ # config.api_key_prefix['Authorization'] = 'Bearer' end api_instance = Ionoscloud::ServersApi.new datacenter_id = 'datacenter_id_example' # String | The unique ID of the data center. -server_id = 'server_id_example' # String | The unique ID of the Server +server_id = 'server_id_example' # String | The unique ID of the server. opts = { pretty: true, # Boolean | Controls whether the response is pretty-printed (with indentations and new lines). depth: 56, # 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 x_contract_number: 56, # Integer | Users with multiple contracts must provide the contract number, against which all API requests are to be executed. offset: 56, # Integer | The first element (from the complete list of the elements) to include in the response (use together with limit for pagination). @@ -267,20 +267,20 @@ ### Parameters | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | | **datacenter_id** | **String** | The unique ID of the data center. | | -| **server_id** | **String** | The unique ID of the Server | | +| **server_id** | **String** | The unique ID of the server. | | | **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&#x3D;0: Only direct properties are included; children (servers and other elements) 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 with multiple contracts must provide the contract number, against which all API requests are to be executed. | [optional] | | **offset** | **Integer** | The first element (from the complete list of the 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 -[**Cdroms**](Cdroms.md) +[**Cdroms**](../models/Cdroms.md) ### Authorization Basic Authentication, Token Authentication @@ -292,13 +292,13 @@ ## datacenters_servers_cdroms_post > <Image> datacenters_servers_cdroms_post(datacenter_id, server_id, cdrom, opts) -Attach a CD-ROM +Attach CD-ROMs -You can attach a CD-ROM to an existing server. You can attach up to 2 CD-ROMs to one server. +Attach a CD-ROM to an existing server. Up to two CD-ROMs can be attached to the same server. ### Examples ```ruby require 'time' @@ -315,20 +315,20 @@ # config.api_key_prefix['Authorization'] = 'Bearer' end api_instance = Ionoscloud::ServersApi.new datacenter_id = 'datacenter_id_example' # String | The unique ID of the data center. -server_id = 'server_id_example' # String | The unique ID of the Server -cdrom = Ionoscloud::Image.new({properties: Ionoscloud::ImageProperties.new({licence_type: 'UNKNOWN'})}) # Image | CD-ROM to be attached +server_id = 'server_id_example' # String | The unique ID of the server. +cdrom = Ionoscloud::Image.new({properties: Ionoscloud::ImageProperties.new({licence_type: 'UNKNOWN'})}) # Image | The CD-ROM to be attached. opts = { pretty: true, # Boolean | Controls whether the response is pretty-printed (with indentations and new lines). depth: 56, # 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 x_contract_number: 56 # Integer | Users with multiple contracts must provide the contract number, against which all API requests are to be executed. } begin - # Attach a CD-ROM + # Attach CD-ROMs result = api_instance.datacenters_servers_cdroms_post(datacenter_id, server_id, cdrom, opts) p result rescue Ionoscloud::ApiError => e puts "Error when calling ServersApi->datacenters_servers_cdroms_post: #{e}" end @@ -340,11 +340,11 @@ > <Array(<Image>, Integer, Hash)> datacenters_servers_cdroms_post_with_http_info(datacenter_id, server_id, cdrom, opts) ```ruby begin - # Attach a CD-ROM + # Attach CD-ROMs data, status_code, headers = api_instance.datacenters_servers_cdroms_post_with_http_info(datacenter_id, server_id, cdrom, opts) p status_code # => 2xx p headers # => { ... } p data # => <Image> rescue Ionoscloud::ApiError => e @@ -355,19 +355,19 @@ ### Parameters | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | | **datacenter_id** | **String** | The unique ID of the data center. | | -| **server_id** | **String** | The unique ID of the Server | | -| **cdrom** | [**Image**](Image.md) | CD-ROM to be attached | | +| **server_id** | **String** | The unique ID of the server. | | +| **cdrom** | [**Image**](Image.md) | The CD-ROM to be attached. | | | **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&#x3D;0: Only direct properties are included; children (servers and other elements) 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 with multiple contracts must provide the contract number, against which all API requests are to be executed. | [optional] | ### Return type -[**Image**](Image.md) +[**Image**](../models/Image.md) ### Authorization Basic Authentication, Token Authentication @@ -379,13 +379,13 @@ ## datacenters_servers_delete > datacenters_servers_delete(datacenter_id, server_id, opts) -Delete a Server +Delete servers -This will remove a server from your datacenter; however, it will not remove the storage volumes attached to the server. You will need to make a separate API call to perform that action +Delete the specified server in your data center. The attached storage volumes will not be removed — a separate API call must be made for these actions. ### Examples ```ruby require 'time' @@ -402,19 +402,19 @@ # config.api_key_prefix['Authorization'] = 'Bearer' end api_instance = Ionoscloud::ServersApi.new datacenter_id = 'datacenter_id_example' # String | The unique ID of the data center. -server_id = 'server_id_example' # String | The unique ID of the Server +server_id = 'server_id_example' # String | The unique ID of the server. opts = { pretty: true, # Boolean | Controls whether the response is pretty-printed (with indentations and new lines). depth: 56, # 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 x_contract_number: 56 # Integer | Users with multiple contracts must provide the contract number, against which all API requests are to be executed. } begin - # Delete a Server + # Delete servers api_instance.datacenters_servers_delete(datacenter_id, server_id, opts) rescue Ionoscloud::ApiError => e puts "Error when calling ServersApi->datacenters_servers_delete: #{e}" end ``` @@ -425,11 +425,11 @@ > <Array(nil, Integer, Hash)> datacenters_servers_delete_with_http_info(datacenter_id, server_id, opts) ```ruby begin - # Delete a Server + # Delete servers data, status_code, headers = api_instance.datacenters_servers_delete_with_http_info(datacenter_id, server_id, opts) p status_code # => 2xx p headers # => { ... } p data # => nil rescue Ionoscloud::ApiError => e @@ -440,11 +440,11 @@ ### Parameters | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | | **datacenter_id** | **String** | The unique ID of the data center. | | -| **server_id** | **String** | The unique ID of the Server | | +| **server_id** | **String** | The unique ID of the server. | | | **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&#x3D;0: Only direct properties are included; children (servers and other elements) 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 with multiple contracts must provide the contract number, against which all API requests are to be executed. | [optional] | ### Return type @@ -463,13 +463,13 @@ ## datacenters_servers_find_by_id > <Server> datacenters_servers_find_by_id(datacenter_id, server_id, opts) -Retrieve a Server +Retrieve servers by ID -Returns information about a server such as its configuration, provisioning status, etc. +Retrieve information about the specified server within the data center, such as its configuration, provisioning status, and so on. ### Examples ```ruby require 'time' @@ -486,19 +486,19 @@ # config.api_key_prefix['Authorization'] = 'Bearer' end api_instance = Ionoscloud::ServersApi.new datacenter_id = 'datacenter_id_example' # String | The unique ID of the data center. -server_id = 'server_id_example' # String | The unique ID of the Server +server_id = 'server_id_example' # String | The unique ID of the server. opts = { pretty: true, # Boolean | Controls whether the response is pretty-printed (with indentations and new lines). depth: 56, # 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 x_contract_number: 56 # Integer | Users with multiple contracts must provide the contract number, against which all API requests are to be executed. } begin - # Retrieve a Server + # Retrieve servers by ID result = api_instance.datacenters_servers_find_by_id(datacenter_id, server_id, opts) p result rescue Ionoscloud::ApiError => e puts "Error when calling ServersApi->datacenters_servers_find_by_id: #{e}" end @@ -510,11 +510,11 @@ > <Array(<Server>, Integer, Hash)> datacenters_servers_find_by_id_with_http_info(datacenter_id, server_id, opts) ```ruby begin - # Retrieve a Server + # Retrieve servers by ID data, status_code, headers = api_instance.datacenters_servers_find_by_id_with_http_info(datacenter_id, server_id, opts) p status_code # => 2xx p headers # => { ... } p data # => <Server> rescue Ionoscloud::ApiError => e @@ -525,18 +525,18 @@ ### Parameters | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | | **datacenter_id** | **String** | The unique ID of the data center. | | -| **server_id** | **String** | The unique ID of the Server | | +| **server_id** | **String** | The unique ID of the server. | | | **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&#x3D;0: Only direct properties are included; children (servers and other elements) 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 with multiple contracts must provide the contract number, against which all API requests are to be executed. | [optional] | ### Return type -[**Server**](Server.md) +[**Server**](../models/Server.md) ### Authorization Basic Authentication, Token Authentication @@ -548,13 +548,13 @@ ## datacenters_servers_get > <Servers> datacenters_servers_get(datacenter_id, opts) -List Servers +List servers -You can retrieve a list of servers within a datacenter +List all servers within the data center. ### Examples ```ruby require 'time' @@ -574,18 +574,18 @@ api_instance = Ionoscloud::ServersApi.new datacenter_id = 'datacenter_id_example' # String | The unique ID of the data center. opts = { pretty: true, # Boolean | Controls whether the response is pretty-printed (with indentations and new lines). depth: 56, # 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 - upgrade_needed: true, # Boolean | It can be used to filter which servers can be upgraded which can not be upgraded. + upgrade_needed: true, # Boolean | Filter servers that can or that cannot be upgraded. x_contract_number: 56, # Integer | Users with multiple contracts must provide the contract number, against which all API requests are to be executed. offset: 56, # Integer | The first element (from the complete list of the 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 Servers + # List servers result = api_instance.datacenters_servers_get(datacenter_id, opts) p result rescue Ionoscloud::ApiError => e puts "Error when calling ServersApi->datacenters_servers_get: #{e}" end @@ -597,11 +597,11 @@ > <Array(<Servers>, Integer, Hash)> datacenters_servers_get_with_http_info(datacenter_id, opts) ```ruby begin - # List Servers + # List servers data, status_code, headers = api_instance.datacenters_servers_get_with_http_info(datacenter_id, opts) p status_code # => 2xx p headers # => { ... } p data # => <Servers> rescue Ionoscloud::ApiError => e @@ -614,18 +614,18 @@ | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | | **datacenter_id** | **String** | The unique ID of the data center. | | | **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&#x3D;0: Only direct properties are included; children (servers and other elements) 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] | -| **upgrade_needed** | **Boolean** | It can be used to filter which servers can be upgraded which can not be upgraded. | [optional] | +| **upgrade_needed** | **Boolean** | Filter servers that can or that cannot be upgraded. | [optional] | | **x_contract_number** | **Integer** | Users with multiple contracts must provide the contract number, against which all API requests are to be executed. | [optional] | | **offset** | **Integer** | The first element (from the complete list of the 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 -[**Servers**](Servers.md) +[**Servers**](../models/Servers.md) ### Authorization Basic Authentication, Token Authentication @@ -637,13 +637,13 @@ ## datacenters_servers_patch > <Server> datacenters_servers_patch(datacenter_id, server_id, server, opts) -Partially modify a Server +Partially modify servers -You can use update attributes of a server +Update the properties of the specified server within the data center. ### Examples ```ruby require 'time' @@ -660,20 +660,20 @@ # config.api_key_prefix['Authorization'] = 'Bearer' end api_instance = Ionoscloud::ServersApi.new datacenter_id = 'datacenter_id_example' # String | The unique ID of the data center. -server_id = 'server_id_example' # String | The unique ID of the server -server = Ionoscloud::ServerProperties.new({cores: 4, ram: 4096}) # ServerProperties | Modified properties of Server +server_id = 'server_id_example' # String | The unique ID of the server. +server = Ionoscloud::ServerProperties.new({cores: 4, ram: 4096}) # ServerProperties | The properties of the server to be updated. opts = { pretty: true, # Boolean | Controls whether the response is pretty-printed (with indentations and new lines). depth: 56, # 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 x_contract_number: 56 # Integer | Users with multiple contracts must provide the contract number, against which all API requests are to be executed. } begin - # Partially modify a Server + # Partially modify servers result = api_instance.datacenters_servers_patch(datacenter_id, server_id, server, opts) p result rescue Ionoscloud::ApiError => e puts "Error when calling ServersApi->datacenters_servers_patch: #{e}" end @@ -685,11 +685,11 @@ > <Array(<Server>, Integer, Hash)> datacenters_servers_patch_with_http_info(datacenter_id, server_id, server, opts) ```ruby begin - # Partially modify a Server + # Partially modify servers data, status_code, headers = api_instance.datacenters_servers_patch_with_http_info(datacenter_id, server_id, server, opts) p status_code # => 2xx p headers # => { ... } p data # => <Server> rescue Ionoscloud::ApiError => e @@ -700,19 +700,19 @@ ### Parameters | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | | **datacenter_id** | **String** | The unique ID of the data center. | | -| **server_id** | **String** | The unique ID of the server | | -| **server** | [**ServerProperties**](ServerProperties.md) | Modified properties of Server | | +| **server_id** | **String** | The unique ID of the server. | | +| **server** | [**ServerProperties**](ServerProperties.md) | The properties of the server 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&#x3D;0: Only direct properties are included; children (servers and other elements) 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 with multiple contracts must provide the contract number, against which all API requests are to be executed. | [optional] | ### Return type -[**Server**](Server.md) +[**Server**](../models/Server.md) ### Authorization Basic Authentication, Token Authentication @@ -724,13 +724,13 @@ ## datacenters_servers_post > <Server> datacenters_servers_post(datacenter_id, server, opts) -Create a Server +Create servers -Creates a server within an existing datacenter. You can configure the boot volume and connect the server to an existing LAN. +Create a server within the specified data center. You can also use this request to configure the boot volumes and connect to existing LANs at the same time. ### Examples ```ruby require 'time' @@ -747,19 +747,19 @@ # config.api_key_prefix['Authorization'] = 'Bearer' end api_instance = Ionoscloud::ServersApi.new datacenter_id = 'datacenter_id_example' # String | The unique ID of the data center. -server = Ionoscloud::Server.new({properties: Ionoscloud::ServerProperties.new({cores: 4, ram: 4096})}) # Server | Server to be created +server = Ionoscloud::Server.new({properties: Ionoscloud::ServerProperties.new({cores: 4, ram: 4096})}) # Server | The server to create. opts = { pretty: true, # Boolean | Controls whether the response is pretty-printed (with indentations and new lines). depth: 56, # 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 x_contract_number: 56 # Integer | Users with multiple contracts must provide the contract number, against which all API requests are to be executed. } begin - # Create a Server + # Create servers result = api_instance.datacenters_servers_post(datacenter_id, server, opts) p result rescue Ionoscloud::ApiError => e puts "Error when calling ServersApi->datacenters_servers_post: #{e}" end @@ -771,11 +771,11 @@ > <Array(<Server>, Integer, Hash)> datacenters_servers_post_with_http_info(datacenter_id, server, opts) ```ruby begin - # Create a Server + # Create servers data, status_code, headers = api_instance.datacenters_servers_post_with_http_info(datacenter_id, server, opts) p status_code # => 2xx p headers # => { ... } p data # => <Server> rescue Ionoscloud::ApiError => e @@ -786,18 +786,18 @@ ### Parameters | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | | **datacenter_id** | **String** | The unique ID of the data center. | | -| **server** | [**Server**](Server.md) | Server to be created | | +| **server** | [**Server**](Server.md) | The server to create. | | | **pretty** | **Boolean** | Controls whether the response is pretty-printed (with indentations and new lines). | [optional][default to true] | | **depth** | **Integer** | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth&#x3D;0: Only direct properties are included; children (servers and other elements) 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 with multiple contracts must provide the contract number, against which all API requests are to be executed. | [optional] | ### Return type -[**Server**](Server.md) +[**Server**](../models/Server.md) ### Authorization Basic Authentication, Token Authentication @@ -809,13 +809,13 @@ ## datacenters_servers_put > <Server> datacenters_servers_put(datacenter_id, server_id, server, opts) -Modify a Server +Modify servers -Allows to modify the attributes of a Server. From v5 onwards 'allowReboot' attribute will no longer be available. For certain server property change it was earlier forced to be provided. Now this behaviour is implicit and backend will do this automatically e.g. in earlier versions, when CPU family changes, the 'allowReboot' property was required to be set to true which will no longer be the case and the server will be rebooted automatically +Modify the properties of the specified server within the data center. Starting with v5, the 'allowReboot' attribute is retired; while previously required for changing certain server properties, this behavior is now implicit, and the backend will perform this automatically. For example, in earlier versions, when the CPU family is changed, 'allowReboot' had to be set to 'true'; this is no longer required, the reboot will be performed automatically. ### Examples ```ruby require 'time' @@ -832,20 +832,20 @@ # config.api_key_prefix['Authorization'] = 'Bearer' end api_instance = Ionoscloud::ServersApi.new datacenter_id = 'datacenter_id_example' # String | The unique ID of the data center. -server_id = 'server_id_example' # String | The unique ID of the server -server = Ionoscloud::Server.new({properties: Ionoscloud::ServerProperties.new({cores: 4, ram: 4096})}) # Server | Modified Server +server_id = 'server_id_example' # String | The unique ID of the server. +server = Ionoscloud::Server.new({properties: Ionoscloud::ServerProperties.new({cores: 4, ram: 4096})}) # Server | The modified server opts = { pretty: true, # Boolean | Controls whether the response is pretty-printed (with indentations and new lines). depth: 56, # 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 x_contract_number: 56 # Integer | Users with multiple contracts must provide the contract number, against which all API requests are to be executed. } begin - # Modify a Server + # Modify servers result = api_instance.datacenters_servers_put(datacenter_id, server_id, server, opts) p result rescue Ionoscloud::ApiError => e puts "Error when calling ServersApi->datacenters_servers_put: #{e}" end @@ -857,11 +857,11 @@ > <Array(<Server>, Integer, Hash)> datacenters_servers_put_with_http_info(datacenter_id, server_id, server, opts) ```ruby begin - # Modify a Server + # Modify servers data, status_code, headers = api_instance.datacenters_servers_put_with_http_info(datacenter_id, server_id, server, opts) p status_code # => 2xx p headers # => { ... } p data # => <Server> rescue Ionoscloud::ApiError => e @@ -872,19 +872,19 @@ ### Parameters | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | | **datacenter_id** | **String** | The unique ID of the data center. | | -| **server_id** | **String** | The unique ID of the server | | -| **server** | [**Server**](Server.md) | Modified Server | | +| **server_id** | **String** | The unique ID of the server. | | +| **server** | [**Server**](Server.md) | The modified server | | | **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&#x3D;0: Only direct properties are included; children (servers and other elements) 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 with multiple contracts must provide the contract number, against which all API requests are to be executed. | [optional] | ### Return type -[**Server**](Server.md) +[**Server**](../models/Server.md) ### Authorization Basic Authentication, Token Authentication @@ -896,13 +896,13 @@ ## datacenters_servers_reboot_post > datacenters_servers_reboot_post(datacenter_id, server_id, opts) -Reboot a Server +Reboot servers -This will force a hard reboot of the server. Do not use this method if you want to gracefully reboot the machine. This is the equivalent of powering off the machine and turning it back on. +Force a hard reboot of the specified server within the data center. Don't use this method if you wish to reboot gracefully. This is an equivalent of powering down a computer and turning it back on. ### Examples ```ruby require 'time' @@ -919,19 +919,19 @@ # config.api_key_prefix['Authorization'] = 'Bearer' end api_instance = Ionoscloud::ServersApi.new datacenter_id = 'datacenter_id_example' # String | The unique ID of the data center. -server_id = 'server_id_example' # String | The unique ID of the Server +server_id = 'server_id_example' # String | The unique ID of the server. opts = { pretty: true, # Boolean | Controls whether the response is pretty-printed (with indentations and new lines). depth: 56, # 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 x_contract_number: 56 # Integer | Users with multiple contracts must provide the contract number, against which all API requests are to be executed. } begin - # Reboot a Server + # Reboot servers api_instance.datacenters_servers_reboot_post(datacenter_id, server_id, opts) rescue Ionoscloud::ApiError => e puts "Error when calling ServersApi->datacenters_servers_reboot_post: #{e}" end ``` @@ -942,11 +942,11 @@ > <Array(nil, Integer, Hash)> datacenters_servers_reboot_post_with_http_info(datacenter_id, server_id, opts) ```ruby begin - # Reboot a Server + # Reboot servers data, status_code, headers = api_instance.datacenters_servers_reboot_post_with_http_info(datacenter_id, server_id, opts) p status_code # => 2xx p headers # => { ... } p data # => nil rescue Ionoscloud::ApiError => e @@ -957,11 +957,11 @@ ### Parameters | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | | **datacenter_id** | **String** | The unique ID of the data center. | | -| **server_id** | **String** | The unique ID of the Server | | +| **server_id** | **String** | The unique ID of the server. | | | **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&#x3D;0: Only direct properties are included; children (servers and other elements) 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 with multiple contracts must provide the contract number, against which all API requests are to be executed. | [optional] | ### Return type @@ -980,13 +980,13 @@ ## datacenters_servers_remote_console_get > <RemoteConsoleUrl> datacenters_servers_remote_console_get(datacenter_id, server_id, opts) -Get the server remote console link +Get Remote Console link -Returns the link with the jwToken to access the server remote console +Retrieve a link with a JSON Web Token for accessing the server's Remote Console. ### Examples ```ruby require 'time' @@ -1003,19 +1003,19 @@ # config.api_key_prefix['Authorization'] = 'Bearer' end api_instance = Ionoscloud::ServersApi.new datacenter_id = 'datacenter_id_example' # String | The unique ID of the data center. -server_id = 'server_id_example' # String | The unique ID of the Server +server_id = 'server_id_example' # String | The unique ID of the server. opts = { pretty: true, # Boolean | Controls whether the response is pretty-printed (with indentations and new lines). depth: 56, # 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 x_contract_number: 56 # Integer | Users with multiple contracts must provide the contract number, against which all API requests are to be executed. } begin - # Get the server remote console link + # Get Remote Console link result = api_instance.datacenters_servers_remote_console_get(datacenter_id, server_id, opts) p result rescue Ionoscloud::ApiError => e puts "Error when calling ServersApi->datacenters_servers_remote_console_get: #{e}" end @@ -1027,11 +1027,11 @@ > <Array(<RemoteConsoleUrl>, Integer, Hash)> datacenters_servers_remote_console_get_with_http_info(datacenter_id, server_id, opts) ```ruby begin - # Get the server remote console link + # Get Remote Console link data, status_code, headers = api_instance.datacenters_servers_remote_console_get_with_http_info(datacenter_id, server_id, opts) p status_code # => 2xx p headers # => { ... } p data # => <RemoteConsoleUrl> rescue Ionoscloud::ApiError => e @@ -1042,18 +1042,18 @@ ### Parameters | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | | **datacenter_id** | **String** | The unique ID of the data center. | | -| **server_id** | **String** | The unique ID of the Server | | +| **server_id** | **String** | The unique ID of the server. | | | **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&#x3D;0: Only direct properties are included; children (servers and other elements) 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 with multiple contracts must provide the contract number, against which all API requests are to be executed. | [optional] | ### Return type -[**RemoteConsoleUrl**](RemoteConsoleUrl.md) +[**RemoteConsoleUrl**](../models/RemoteConsoleUrl.md) ### Authorization Basic Authentication, Token Authentication @@ -1065,13 +1065,13 @@ ## datacenters_servers_resume_post > datacenters_servers_resume_post(datacenter_id, server_id, opts) -Resume a Cube Server +Resume Cubes instances -This will resume a suspended server. The operation can only be applied to suspended Cube servers. No billing event will be generated. +Resume a suspended Cube instance; no billing event will be generated. This operation is only supported for the Cubes. ### Examples ```ruby require 'time' @@ -1088,19 +1088,19 @@ # config.api_key_prefix['Authorization'] = 'Bearer' end api_instance = Ionoscloud::ServersApi.new datacenter_id = 'datacenter_id_example' # String | The unique ID of the data center. -server_id = 'server_id_example' # String | The unique ID of the Server +server_id = 'server_id_example' # String | The unique ID of the server. opts = { pretty: true, # Boolean | Controls whether the response is pretty-printed (with indentations and new lines). depth: 56, # 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 x_contract_number: 56 # Integer | Users with multiple contracts must provide the contract number, against which all API requests are to be executed. } begin - # Resume a Cube Server + # Resume Cubes instances api_instance.datacenters_servers_resume_post(datacenter_id, server_id, opts) rescue Ionoscloud::ApiError => e puts "Error when calling ServersApi->datacenters_servers_resume_post: #{e}" end ``` @@ -1111,11 +1111,11 @@ > <Array(nil, Integer, Hash)> datacenters_servers_resume_post_with_http_info(datacenter_id, server_id, opts) ```ruby begin - # Resume a Cube Server + # Resume Cubes instances data, status_code, headers = api_instance.datacenters_servers_resume_post_with_http_info(datacenter_id, server_id, opts) p status_code # => 2xx p headers # => { ... } p data # => nil rescue Ionoscloud::ApiError => e @@ -1126,11 +1126,11 @@ ### Parameters | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | | **datacenter_id** | **String** | The unique ID of the data center. | | -| **server_id** | **String** | The unique ID of the Server | | +| **server_id** | **String** | The unique ID of the server. | | | **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&#x3D;0: Only direct properties are included; children (servers and other elements) 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 with multiple contracts must provide the contract number, against which all API requests are to be executed. | [optional] | ### Return type @@ -1149,13 +1149,13 @@ ## datacenters_servers_start_post > datacenters_servers_start_post(datacenter_id, server_id, opts) -Start a Server +Start servers -This will start a server. If the server's public IP was deallocated then a new IP will be assigned +Start the specified server within the data center; if the server's public IP address has been deallocated, a new IP address will be assigned. ### Examples ```ruby require 'time' @@ -1172,19 +1172,19 @@ # config.api_key_prefix['Authorization'] = 'Bearer' end api_instance = Ionoscloud::ServersApi.new datacenter_id = 'datacenter_id_example' # String | The unique ID of the data center. -server_id = 'server_id_example' # String | The unique ID of the Server +server_id = 'server_id_example' # String | The unique ID of the server. opts = { pretty: true, # Boolean | Controls whether the response is pretty-printed (with indentations and new lines). depth: 56, # 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 x_contract_number: 56 # Integer | Users with multiple contracts must provide the contract number, against which all API requests are to be executed. } begin - # Start a Server + # Start servers api_instance.datacenters_servers_start_post(datacenter_id, server_id, opts) rescue Ionoscloud::ApiError => e puts "Error when calling ServersApi->datacenters_servers_start_post: #{e}" end ``` @@ -1195,11 +1195,11 @@ > <Array(nil, Integer, Hash)> datacenters_servers_start_post_with_http_info(datacenter_id, server_id, opts) ```ruby begin - # Start a Server + # Start servers data, status_code, headers = api_instance.datacenters_servers_start_post_with_http_info(datacenter_id, server_id, opts) p status_code # => 2xx p headers # => { ... } p data # => nil rescue Ionoscloud::ApiError => e @@ -1210,11 +1210,11 @@ ### Parameters | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | | **datacenter_id** | **String** | The unique ID of the data center. | | -| **server_id** | **String** | The unique ID of the Server | | +| **server_id** | **String** | The unique ID of the server. | | | **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&#x3D;0: Only direct properties are included; children (servers and other elements) 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 with multiple contracts must provide the contract number, against which all API requests are to be executed. | [optional] | ### Return type @@ -1233,13 +1233,13 @@ ## datacenters_servers_stop_post > datacenters_servers_stop_post(datacenter_id, server_id, opts) -Stop a Server +Stop VMs -This will stop a server. The machine will be forcefully powered off, billing will cease, and the public IP, if one is allocated, will be deallocated. The operation is not supported for Cube servers. +Stop the specified server within the data center: the VM will be forcefully shut down, the billing will cease, and any allocated public IPs will be deallocated. This operation is not supported for the Cubes. ### Examples ```ruby require 'time' @@ -1256,19 +1256,19 @@ # config.api_key_prefix['Authorization'] = 'Bearer' end api_instance = Ionoscloud::ServersApi.new datacenter_id = 'datacenter_id_example' # String | The unique ID of the data center. -server_id = 'server_id_example' # String | The unique ID of the Server +server_id = 'server_id_example' # String | The unique ID of the server. opts = { pretty: true, # Boolean | Controls whether the response is pretty-printed (with indentations and new lines). depth: 56, # 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 x_contract_number: 56 # Integer | Users with multiple contracts must provide the contract number, against which all API requests are to be executed. } begin - # Stop a Server + # Stop VMs api_instance.datacenters_servers_stop_post(datacenter_id, server_id, opts) rescue Ionoscloud::ApiError => e puts "Error when calling ServersApi->datacenters_servers_stop_post: #{e}" end ``` @@ -1279,11 +1279,11 @@ > <Array(nil, Integer, Hash)> datacenters_servers_stop_post_with_http_info(datacenter_id, server_id, opts) ```ruby begin - # Stop a Server + # Stop VMs data, status_code, headers = api_instance.datacenters_servers_stop_post_with_http_info(datacenter_id, server_id, opts) p status_code # => 2xx p headers # => { ... } p data # => nil rescue Ionoscloud::ApiError => e @@ -1294,11 +1294,11 @@ ### Parameters | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | | **datacenter_id** | **String** | The unique ID of the data center. | | -| **server_id** | **String** | The unique ID of the Server | | +| **server_id** | **String** | The unique ID of the server. | | | **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&#x3D;0: Only direct properties are included; children (servers and other elements) 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 with multiple contracts must provide the contract number, against which all API requests are to be executed. | [optional] | ### Return type @@ -1317,13 +1317,13 @@ ## datacenters_servers_suspend_post > datacenters_servers_suspend_post(datacenter_id, server_id, opts) -Suspend a Cube Server +Suspend Cubes instances -This will suspend a server. The operation can only be applied to Cube servers. Note: The virtual machine will not be deleted, and the consumed resources will continue to be billed. +Suspend the specified Cubes instance within the data center. The instance will not be deleted, and allocated resources will continue to be billed. This operation is only supported for the Cubes. ### Examples ```ruby require 'time' @@ -1340,19 +1340,19 @@ # config.api_key_prefix['Authorization'] = 'Bearer' end api_instance = Ionoscloud::ServersApi.new datacenter_id = 'datacenter_id_example' # String | The unique ID of the data center. -server_id = 'server_id_example' # String | The unique ID of the Server +server_id = 'server_id_example' # String | The unique ID of the server. opts = { pretty: true, # Boolean | Controls whether the response is pretty-printed (with indentations and new lines). depth: 56, # 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 x_contract_number: 56 # Integer | Users with multiple contracts must provide the contract number, against which all API requests are to be executed. } begin - # Suspend a Cube Server + # Suspend Cubes instances api_instance.datacenters_servers_suspend_post(datacenter_id, server_id, opts) rescue Ionoscloud::ApiError => e puts "Error when calling ServersApi->datacenters_servers_suspend_post: #{e}" end ``` @@ -1363,11 +1363,11 @@ > <Array(nil, Integer, Hash)> datacenters_servers_suspend_post_with_http_info(datacenter_id, server_id, opts) ```ruby begin - # Suspend a Cube Server + # Suspend Cubes instances data, status_code, headers = api_instance.datacenters_servers_suspend_post_with_http_info(datacenter_id, server_id, opts) p status_code # => 2xx p headers # => { ... } p data # => nil rescue Ionoscloud::ApiError => e @@ -1378,11 +1378,11 @@ ### Parameters | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | | **datacenter_id** | **String** | The unique ID of the data center. | | -| **server_id** | **String** | The unique ID of the Server | | +| **server_id** | **String** | The unique ID of the server. | | | **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&#x3D;0: Only direct properties are included; children (servers and other elements) 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 with multiple contracts must provide the contract number, against which all API requests are to be executed. | [optional] | ### Return type @@ -1401,13 +1401,13 @@ ## datacenters_servers_token_get > <Token> datacenters_servers_token_get(datacenter_id, server_id, opts) -Get the server's jwToken +Get JASON Web Token -Returns the server json web token to be used for login operations (ex: accessing the server console) +Retrieve a JSON Web Token from the server for use in login operations (such as accessing the server's console). ### Examples ```ruby require 'time' @@ -1424,19 +1424,19 @@ # config.api_key_prefix['Authorization'] = 'Bearer' end api_instance = Ionoscloud::ServersApi.new datacenter_id = 'datacenter_id_example' # String | The unique ID of the data center. -server_id = 'server_id_example' # String | The unique ID of the Server +server_id = 'server_id_example' # String | The unique ID of the server. opts = { pretty: true, # Boolean | Controls whether the response is pretty-printed (with indentations and new lines). depth: 56, # 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 x_contract_number: 56 # Integer | Users with multiple contracts must provide the contract number, against which all API requests are to be executed. } begin - # Get the server's jwToken + # Get JASON Web Token result = api_instance.datacenters_servers_token_get(datacenter_id, server_id, opts) p result rescue Ionoscloud::ApiError => e puts "Error when calling ServersApi->datacenters_servers_token_get: #{e}" end @@ -1448,11 +1448,11 @@ > <Array(<Token>, Integer, Hash)> datacenters_servers_token_get_with_http_info(datacenter_id, server_id, opts) ```ruby begin - # Get the server's jwToken + # Get JASON Web Token data, status_code, headers = api_instance.datacenters_servers_token_get_with_http_info(datacenter_id, server_id, opts) p status_code # => 2xx p headers # => { ... } p data # => <Token> rescue Ionoscloud::ApiError => e @@ -1463,18 +1463,18 @@ ### Parameters | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | | **datacenter_id** | **String** | The unique ID of the data center. | | -| **server_id** | **String** | The unique ID of the Server | | +| **server_id** | **String** | The unique ID of the server. | | | **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&#x3D;0: Only direct properties are included; children (servers and other elements) 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 with multiple contracts must provide the contract number, against which all API requests are to be executed. | [optional] | ### Return type -[**Token**](Token.md) +[**Token**](../models/Token.md) ### Authorization Basic Authentication, Token Authentication @@ -1486,13 +1486,13 @@ ## datacenters_servers_upgrade_post > datacenters_servers_upgrade_post(datacenter_id, server_id, opts) -Upgrade a Server +Upgrade servers -This will upgrade the version of the server, if needed. To verify if there is an upgrade available for a server, call '/datacenters/{datacenterId}/servers?upgradeNeeded=true' +Upgrade the server version, if needed. To determine if an upgrade is available, execute the following call: '/datacenters/{datacenterId}/servers?upgradeNeeded=true' ### Examples ```ruby require 'time' @@ -1509,19 +1509,19 @@ # config.api_key_prefix['Authorization'] = 'Bearer' end api_instance = Ionoscloud::ServersApi.new datacenter_id = 'datacenter_id_example' # String | The unique ID of the data center. -server_id = 'server_id_example' # String | The unique ID of the Server +server_id = 'server_id_example' # String | The unique ID of the server. opts = { pretty: true, # Boolean | Controls whether the response is pretty-printed (with indentations and new lines). depth: 56, # 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 x_contract_number: 56 # Integer | Users with multiple contracts must provide the contract number, against which all API requests are to be executed. } begin - # Upgrade a Server + # Upgrade servers api_instance.datacenters_servers_upgrade_post(datacenter_id, server_id, opts) rescue Ionoscloud::ApiError => e puts "Error when calling ServersApi->datacenters_servers_upgrade_post: #{e}" end ``` @@ -1532,11 +1532,11 @@ > <Array(nil, Integer, Hash)> datacenters_servers_upgrade_post_with_http_info(datacenter_id, server_id, opts) ```ruby begin - # Upgrade a Server + # Upgrade servers data, status_code, headers = api_instance.datacenters_servers_upgrade_post_with_http_info(datacenter_id, server_id, opts) p status_code # => 2xx p headers # => { ... } p data # => nil rescue Ionoscloud::ApiError => e @@ -1547,11 +1547,11 @@ ### Parameters | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | | **datacenter_id** | **String** | The unique ID of the data center. | | -| **server_id** | **String** | The unique ID of the Server | | +| **server_id** | **String** | The unique ID of the server. | | | **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&#x3D;0: Only direct properties are included; children (servers and other elements) 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 with multiple contracts must provide the contract number, against which all API requests are to be executed. | [optional] | ### Return type @@ -1570,13 +1570,13 @@ ## datacenters_servers_volumes_delete > datacenters_servers_volumes_delete(datacenter_id, server_id, volume_id, opts) -Detach a volume +Detach volumes -This will detach the volume from the server. This will not delete the volume from your datacenter. You will need to make a separate request to perform a deletion +Detach the specified volume from the server without deleting it from the data center. A separate request must be made to perform the deletion. ### Examples ```ruby require 'time' @@ -1593,20 +1593,20 @@ # config.api_key_prefix['Authorization'] = 'Bearer' end api_instance = Ionoscloud::ServersApi.new datacenter_id = 'datacenter_id_example' # String | The unique ID of the data center. -server_id = 'server_id_example' # String | The unique ID of the Server -volume_id = 'volume_id_example' # String | The unique ID of the Volume +server_id = 'server_id_example' # String | The unique ID of the server. +volume_id = 'volume_id_example' # String | The unique ID of the volume. opts = { pretty: true, # Boolean | Controls whether the response is pretty-printed (with indentations and new lines). depth: 56, # 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 x_contract_number: 56 # Integer | Users with multiple contracts must provide the contract number, against which all API requests are to be executed. } begin - # Detach a volume + # Detach volumes api_instance.datacenters_servers_volumes_delete(datacenter_id, server_id, volume_id, opts) rescue Ionoscloud::ApiError => e puts "Error when calling ServersApi->datacenters_servers_volumes_delete: #{e}" end ``` @@ -1617,11 +1617,11 @@ > <Array(nil, Integer, Hash)> datacenters_servers_volumes_delete_with_http_info(datacenter_id, server_id, volume_id, opts) ```ruby begin - # Detach a volume + # Detach volumes data, status_code, headers = api_instance.datacenters_servers_volumes_delete_with_http_info(datacenter_id, server_id, volume_id, opts) p status_code # => 2xx p headers # => { ... } p data # => nil rescue Ionoscloud::ApiError => e @@ -1632,12 +1632,12 @@ ### Parameters | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | | **datacenter_id** | **String** | The unique ID of the data center. | | -| **server_id** | **String** | The unique ID of the Server | | -| **volume_id** | **String** | The unique ID of the Volume | | +| **server_id** | **String** | The unique ID of the server. | | +| **volume_id** | **String** | The unique ID of the volume. | | | **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&#x3D;0: Only direct properties are included; children (servers and other elements) 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 with multiple contracts must provide the contract number, against which all API requests are to be executed. | [optional] | ### Return type @@ -1656,13 +1656,13 @@ ## datacenters_servers_volumes_find_by_id > <Volume> datacenters_servers_volumes_find_by_id(datacenter_id, server_id, volume_id, opts) -Retrieve an attached volume +Retrieve attached volumes -This will retrieve the properties of an attached volume. +Retrieve the properties of the volume, attached to the specified server. ### Examples ```ruby require 'time' @@ -1679,20 +1679,20 @@ # config.api_key_prefix['Authorization'] = 'Bearer' end api_instance = Ionoscloud::ServersApi.new datacenter_id = 'datacenter_id_example' # String | The unique ID of the data center. -server_id = 'server_id_example' # String | The unique ID of the Server -volume_id = 'volume_id_example' # String | The unique ID of the Volume +server_id = 'server_id_example' # String | The unique ID of the server. +volume_id = 'volume_id_example' # String | The unique ID of the volume. opts = { pretty: true, # Boolean | Controls whether the response is pretty-printed (with indentations and new lines). depth: 56, # 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 x_contract_number: 56 # Integer | Users with multiple contracts must provide the contract number, against which all API requests are to be executed. } begin - # Retrieve an attached volume + # Retrieve attached volumes result = api_instance.datacenters_servers_volumes_find_by_id(datacenter_id, server_id, volume_id, opts) p result rescue Ionoscloud::ApiError => e puts "Error when calling ServersApi->datacenters_servers_volumes_find_by_id: #{e}" end @@ -1704,11 +1704,11 @@ > <Array(<Volume>, Integer, Hash)> datacenters_servers_volumes_find_by_id_with_http_info(datacenter_id, server_id, volume_id, opts) ```ruby begin - # Retrieve an attached volume + # Retrieve attached volumes data, status_code, headers = api_instance.datacenters_servers_volumes_find_by_id_with_http_info(datacenter_id, server_id, volume_id, opts) p status_code # => 2xx p headers # => { ... } p data # => <Volume> rescue Ionoscloud::ApiError => e @@ -1719,19 +1719,19 @@ ### Parameters | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | | **datacenter_id** | **String** | The unique ID of the data center. | | -| **server_id** | **String** | The unique ID of the Server | | -| **volume_id** | **String** | The unique ID of the Volume | | +| **server_id** | **String** | The unique ID of the server. | | +| **volume_id** | **String** | The unique ID of the volume. | | | **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&#x3D;0: Only direct properties are included; children (servers and other elements) 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 with multiple contracts must provide the contract number, against which all API requests are to be executed. | [optional] | ### Return type -[**Volume**](Volume.md) +[**Volume**](../models/Volume.md) ### Authorization Basic Authentication, Token Authentication @@ -1743,13 +1743,13 @@ ## datacenters_servers_volumes_get > <AttachedVolumes> datacenters_servers_volumes_get(datacenter_id, server_id, opts) -List Attached Volumes +List attached volumes -You can retrieve a list of volumes attached to the server +List all volumes, attached to the specified server. ### Examples ```ruby require 'time' @@ -1761,21 +1761,21 @@ config.password = 'YOUR PASSWORD' end api_instance = Ionoscloud::ServersApi.new datacenter_id = 'datacenter_id_example' # String | The unique ID of the data center. -server_id = 'server_id_example' # String | The unique ID of the Server +server_id = 'server_id_example' # String | The unique ID of the server. opts = { pretty: true, # Boolean | Controls whether the response is pretty-printed (with indentations and new lines). depth: 56, # 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 x_contract_number: 56, # Integer | Users with multiple contracts must provide the contract number, against which all API requests are to be executed. offset: 56, # Integer | The first element (from the complete list of the 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 Attached Volumes + # List attached volumes result = api_instance.datacenters_servers_volumes_get(datacenter_id, server_id, opts) p result rescue Ionoscloud::ApiError => e puts "Error when calling ServersApi->datacenters_servers_volumes_get: #{e}" end @@ -1787,11 +1787,11 @@ > <Array(<AttachedVolumes>, Integer, Hash)> datacenters_servers_volumes_get_with_http_info(datacenter_id, server_id, opts) ```ruby begin - # List Attached Volumes + # List attached volumes data, status_code, headers = api_instance.datacenters_servers_volumes_get_with_http_info(datacenter_id, server_id, opts) p status_code # => 2xx p headers # => { ... } p data # => <AttachedVolumes> rescue Ionoscloud::ApiError => e @@ -1802,20 +1802,20 @@ ### Parameters | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | | **datacenter_id** | **String** | The unique ID of the data center. | | -| **server_id** | **String** | The unique ID of the Server | | +| **server_id** | **String** | The unique ID of the server. | | | **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&#x3D;0: Only direct properties are included; children (servers and other elements) 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 with multiple contracts must provide the contract number, against which all API requests are to be executed. | [optional] | | **offset** | **Integer** | The first element (from the complete list of the 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 -[**AttachedVolumes**](AttachedVolumes.md) +[**AttachedVolumes**](../models/AttachedVolumes.md) ### Authorization Basic Authentication @@ -1827,13 +1827,13 @@ ## datacenters_servers_volumes_post > <Volume> datacenters_servers_volumes_post(datacenter_id, server_id, volume, opts) -Attach a volume +Attach volumes -This will attach a pre-existing storage volume to the server. It is also possible to create and attach a volume in one step just by providing a new volume description as payload. Combine count of Nics and volumes attached to the server should not exceed size 24. +Attach an existing storage volume to the specified server. A volume scan also be created and attached in one step by providing the new volume description as payload. The combined total of attached volumes and NICs cannot exceed 24 per server. ### Examples ```ruby require 'time' @@ -1845,20 +1845,20 @@ config.password = 'YOUR PASSWORD' end api_instance = Ionoscloud::ServersApi.new datacenter_id = 'datacenter_id_example' # String | The unique ID of the data center. -server_id = 'server_id_example' # String | The unique ID of the Server -volume = Ionoscloud::Volume.new({properties: Ionoscloud::VolumeProperties.new({size: 100.0})}) # Volume | Volume to be attached (created and attached) +server_id = 'server_id_example' # String | The unique ID of the server. +volume = Ionoscloud::Volume.new({properties: Ionoscloud::VolumeProperties.new({size: 100.0})}) # Volume | The volume to be attached (or created and attached). opts = { pretty: true, # Boolean | Controls whether the response is pretty-printed (with indentations and new lines). depth: 56, # 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 x_contract_number: 56 # Integer | Users with multiple contracts must provide the contract number, against which all API requests are to be executed. } begin - # Attach a volume + # Attach volumes result = api_instance.datacenters_servers_volumes_post(datacenter_id, server_id, volume, opts) p result rescue Ionoscloud::ApiError => e puts "Error when calling ServersApi->datacenters_servers_volumes_post: #{e}" end @@ -1870,11 +1870,11 @@ > <Array(<Volume>, Integer, Hash)> datacenters_servers_volumes_post_with_http_info(datacenter_id, server_id, volume, opts) ```ruby begin - # Attach a volume + # Attach volumes data, status_code, headers = api_instance.datacenters_servers_volumes_post_with_http_info(datacenter_id, server_id, volume, opts) p status_code # => 2xx p headers # => { ... } p data # => <Volume> rescue Ionoscloud::ApiError => e @@ -1885,18 +1885,18 @@ ### Parameters | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | | **datacenter_id** | **String** | The unique ID of the data center. | | -| **server_id** | **String** | The unique ID of the Server | | -| **volume** | [**Volume**](Volume.md) | Volume to be attached (created and attached) | | +| **server_id** | **String** | The unique ID of the server. | | +| **volume** | [**Volume**](Volume.md) | The volume to be attached (or created and attached). | | | **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&#x3D;0: Only direct properties are included; children (servers and other elements) 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 with multiple contracts must provide the contract number, against which all API requests are to be executed. | [optional] | ### Return type -[**Volume**](Volume.md) +[**Volume**](../models/Volume.md) ### Authorization Basic Authentication