Detachs the specified CD-ROM from the server. Detaching a CD-ROM deletes the CD-ROM. The image will not be deleted. Note that detaching a CD-ROM leads to a reset of the server.
Examples
require'time'require'ionoscloud'# setup authorizationIonoscloud.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'endapi_instance =Ionoscloud::ServersApi.newdatacenter_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.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, for which all API requests are to be executed.
}begin# Detach a CD-ROM by ID api_instance.datacenters_servers_cdroms_delete(datacenter_id, server_id, cdrom_id, opts)rescueIonoscloud::ApiError=> eputs"Error when calling ServersApi->datacenters_servers_cdroms_delete: #{e}"end
Using the datacenters_servers_cdroms_delete_with_http_info variant
This returns an Array which contains the response data (nil in this case), status code and headers.
begin# Detach a CD-ROM by ID data, status_code, headers = api_instance.datacenters_servers_cdroms_delete_with_http_info(datacenter_id, server_id, cdrom_id, opts)
p status_code # => 2xxp headers # => { ... }p data # => nilrescueIonoscloud::ApiError=> eputs"Error when calling ServersApi->datacenters_servers_cdroms_delete_with_http_info: #{e}"end
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.
pretty
Boolean
Controls whether the response is pretty-printed (with indentations and new lines).
[optional][default to true]
depth
Integer
Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on
[optional][default to 0]
x_contract_number
Integer
Users with multiple contracts must provide the contract number, for which all API requests are to be executed.
Retrieves the properties of the CD-ROM attached to the specified server.
Examples
require'time'require'ionoscloud'# setup authorizationIonoscloud.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'endapi_instance =Ionoscloud::ServersApi.newdatacenter_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.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, for which all API requests are to be executed.
}begin# Get Attached CD-ROM by ID result = api_instance.datacenters_servers_cdroms_find_by_id(datacenter_id, server_id, cdrom_id, opts)p resultrescueIonoscloud::ApiError=> eputs"Error when calling ServersApi->datacenters_servers_cdroms_find_by_id: #{e}"end
Using the datacenters_servers_cdroms_find_by_id_with_http_info variant
This returns an Array which contains the response data, status code and headers.
begin# Get Attached CD-ROM by ID 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 # => 2xxp headers # => { ... }p data # => <Image>rescueIonoscloud::ApiError=> eputs"Error when calling ServersApi->datacenters_servers_cdroms_find_by_id_with_http_info: #{e}"end
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.
pretty
Boolean
Controls whether the response is pretty-printed (with indentations and new lines).
[optional][default to true]
depth
Integer
Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on
[optional][default to 0]
x_contract_number
Integer
Users with multiple contracts must provide the contract number, for which all API requests are to be executed.
Lists all CD-ROMs attached to the specified server.
Examples
require'time'require'ionoscloud'# setup authorizationIonoscloud.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'endapi_instance =Ionoscloud::ServersApi.newdatacenter_id ='datacenter_id_example'# String | The unique ID of the data center.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, for 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 (used together with <b><i>limit</i></b> for pagination).
limit: 56# Integer | The maximum number of elements to return (use together with offset for pagination).}begin# Get Attached CD-ROMs result = api_instance.datacenters_servers_cdroms_get(datacenter_id, server_id, opts)p resultrescueIonoscloud::ApiError=> eputs"Error when calling ServersApi->datacenters_servers_cdroms_get: #{e}"end
Using the datacenters_servers_cdroms_get_with_http_info variant
This returns an Array which contains the response data, status code and headers.
begin# Get Attached CD-ROMs data, status_code, headers = api_instance.datacenters_servers_cdroms_get_with_http_info(datacenter_id, server_id, opts)
p status_code # => 2xxp headers # => { ... }p data # => <Cdroms>rescueIonoscloud::ApiError=> eputs"Error when calling ServersApi->datacenters_servers_cdroms_get_with_http_info: #{e}"end
Parameters
Name
Type
Description
Notes
datacenter_id
String
The unique ID of the data center.
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=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on
[optional][default to 0]
x_contract_number
Integer
Users with multiple contracts must provide the contract number, for 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 (used together with <b><i>limit</i></b> for pagination).
[optional][default to 0]
limit
Integer
The maximum number of elements to return (use together with offset for pagination).
Attachs a CD-ROM to an existing server specified by its ID. CD-ROMs cannot be created stand-alone like volumes. They are either attached to a server or do not exist. They always have an ISO-Image associated; empty CD-ROMs can not be provisioned. It is possible to attach up to two CD-ROMs to the same server. Note that attaching a CD-ROM leads to a reset of the server.
Examples
require'time'require'ionoscloud'# setup authorizationIonoscloud.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'endapi_instance =Ionoscloud::ServersApi.newdatacenter_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 | 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, for which all API requests are to be executed.
}begin# Attach a CD-ROM result = api_instance.datacenters_servers_cdroms_post(datacenter_id, server_id, cdrom, opts)p resultrescueIonoscloud::ApiError=> eputs"Error when calling ServersApi->datacenters_servers_cdroms_post: #{e}"end
Using the datacenters_servers_cdroms_post_with_http_info variant
This returns an Array which contains the response data, status code and headers.
Controls whether the response is pretty-printed (with indentations and new lines).
[optional][default to true]
depth
Integer
Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on
[optional][default to 0]
x_contract_number
Integer
Users with multiple contracts must provide the contract number, for which all API requests are to be executed.
Delete the specified server in your data center. The attached storage volumes will also be removed if the query parameter is set to true otherwise a separate API call must be made for these actions.
Examples
require'time'require'ionoscloud'# setup authorizationIonoscloud.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'endapi_instance =Ionoscloud::ServersApi.newdatacenter_id ='datacenter_id_example'# String | The unique ID of the data center.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, for which all API requests are to be executed.
delete_volumes: true# Boolean | If true, all attached storage volumes will also be deleted.}begin# Delete servers api_instance.datacenters_servers_delete(datacenter_id, server_id, opts)rescueIonoscloud::ApiError=> eputs"Error when calling ServersApi->datacenters_servers_delete: #{e}"end
Using the datacenters_servers_delete_with_http_info variant
This returns an Array which contains the response data (nil in this case), status code and headers.
Controls whether the response is pretty-printed (with indentations and new lines).
[optional][default to true]
depth
Integer
Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on
[optional][default to 0]
x_contract_number
Integer
Users with multiple contracts must provide the contract number, for which all API requests are to be executed.
[optional]
delete_volumes
Boolean
If true, all attached storage volumes will also be deleted.
Retrieve information about the specified server within the data center, such as its configuration, provisioning status, and so on.
Examples
require'time'require'ionoscloud'# setup authorizationIonoscloud.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'endapi_instance =Ionoscloud::ServersApi.newdatacenter_id ='datacenter_id_example'# String | The unique ID of the data center.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, for which all API requests are to be executed.
}begin# Retrieve servers by ID result = api_instance.datacenters_servers_find_by_id(datacenter_id, server_id, opts)p resultrescueIonoscloud::ApiError=> eputs"Error when calling ServersApi->datacenters_servers_find_by_id: #{e}"end
Using the datacenters_servers_find_by_id_with_http_info variant
This returns an Array which contains the response data, status code and headers.
begin# 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 # => 2xxp headers # => { ... }p data # => <Server>rescueIonoscloud::ApiError=> eputs"Error when calling ServersApi->datacenters_servers_find_by_id_with_http_info: #{e}"end
Parameters
Name
Type
Description
Notes
datacenter_id
String
The unique ID of the data center.
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=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on
[optional][default to 0]
x_contract_number
Integer
Users with multiple contracts must provide the contract number, for which all API requests are to be executed.
require'time'require'ionoscloud'# setup authorizationIonoscloud.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'endapi_instance =Ionoscloud::ServersApi.newdatacenter_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 | Filter servers that can or that cannot be upgraded. x_contract_number: 56, # Integer | Users with multiple contracts must provide the contract number, for 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 (used together with <b><i>limit</i></b> for pagination).
limit: 56# Integer | The maximum number of elements to return (use together with offset for pagination).}begin# List servers result = api_instance.datacenters_servers_get(datacenter_id, opts)p resultrescueIonoscloud::ApiError=> eputs"Error when calling ServersApi->datacenters_servers_get: #{e}"end
Using the datacenters_servers_get_with_http_info variant
This returns an Array which contains the response data, status code and headers.
begin# List servers data, status_code, headers = api_instance.datacenters_servers_get_with_http_info(datacenter_id, opts)p status_code # => 2xxp headers # => { ... }p data # => <Servers>rescueIonoscloud::ApiError=> eputs"Error when calling ServersApi->datacenters_servers_get_with_http_info: #{e}"end
Parameters
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=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on
[optional][default to 0]
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, for 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 (used together with <b><i>limit</i></b> for pagination).
[optional][default to 0]
limit
Integer
The maximum number of elements to return (use together with offset for pagination).
Update the properties of the specified server within the data center.
Examples
require'time'require'ionoscloud'# setup authorizationIonoscloud.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'endapi_instance =Ionoscloud::ServersApi.newdatacenter_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# 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, for which all API requests are to be executed.
}begin# Partially modify servers result = api_instance.datacenters_servers_patch(datacenter_id, server_id, server, opts)p resultrescueIonoscloud::ApiError=> eputs"Error when calling ServersApi->datacenters_servers_patch: #{e}"end
Using the datacenters_servers_patch_with_http_info variant
This returns an Array which contains the response data, status code and headers.
Controls whether the response is pretty-printed (with indentations and new lines).
[optional][default to true]
depth
Integer
Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on
[optional][default to 0]
x_contract_number
Integer
Users with multiple contracts must provide the contract number, for which all API requests are to be executed.
Creates 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
require'time'require'ionoscloud'# setup authorizationIonoscloud.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'endapi_instance =Ionoscloud::ServersApi.newdatacenter_id ='datacenter_id_example'# String | The unique ID of the data center.server =Ionoscloud::Server.new({properties: Ionoscloud::ServerProperties.new}) # 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, for which all API requests are to be executed.
}begin# Create a Server result = api_instance.datacenters_servers_post(datacenter_id, server, opts)p resultrescueIonoscloud::ApiError=> eputs"Error when calling ServersApi->datacenters_servers_post: #{e}"end
Using the datacenters_servers_post_with_http_info variant
This returns an Array which contains the response data, status code and headers.
Controls whether the response is pretty-printed (with indentations and new lines).
[optional][default to true]
depth
Integer
Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on
[optional][default to 0]
x_contract_number
Integer
Users with multiple contracts must provide the contract number, for which all API requests are to be executed.
Modifies 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
require'time'require'ionoscloud'# setup authorizationIonoscloud.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'endapi_instance =Ionoscloud::ServersApi.newdatacenter_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}) # Server | The modified serveropts = { 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, for which all API requests are to be executed.
}begin# Modify a Server by ID result = api_instance.datacenters_servers_put(datacenter_id, server_id, server, opts)p resultrescueIonoscloud::ApiError=> eputs"Error when calling ServersApi->datacenters_servers_put: #{e}"end
Using the datacenters_servers_put_with_http_info variant
This returns an Array which contains the response data, status code and headers.
begin# Modify a Server by ID data, status_code, headers = api_instance.datacenters_servers_put_with_http_info(datacenter_id, server_id, server, opts)
p status_code # => 2xxp headers # => { ... }p data # => <Server>rescueIonoscloud::ApiError=> eputs"Error when calling ServersApi->datacenters_servers_put_with_http_info: #{e}"end
Controls whether the response is pretty-printed (with indentations and new lines).
[optional][default to true]
depth
Integer
Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on
[optional][default to 0]
x_contract_number
Integer
Users with multiple contracts must provide the contract number, for which all API requests are to be executed.
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
require'time'require'ionoscloud'# setup authorizationIonoscloud.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'endapi_instance =Ionoscloud::ServersApi.newdatacenter_id ='datacenter_id_example'# String | The unique ID of the data center.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, for which all API requests are to be executed.
}begin# Reboot servers api_instance.datacenters_servers_reboot_post(datacenter_id, server_id, opts)rescueIonoscloud::ApiError=> eputs"Error when calling ServersApi->datacenters_servers_reboot_post: #{e}"end
Using the datacenters_servers_reboot_post_with_http_info variant
This returns an Array which contains the response data (nil in this case), status code and headers.
begin# Reboot servers data, status_code, headers = api_instance.datacenters_servers_reboot_post_with_http_info(datacenter_id, server_id, opts)
p status_code # => 2xxp headers # => { ... }p data # => nilrescueIonoscloud::ApiError=> eputs"Error when calling ServersApi->datacenters_servers_reboot_post_with_http_info: #{e}"end
Parameters
Name
Type
Description
Notes
datacenter_id
String
The unique ID of the data center.
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=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on
[optional][default to 0]
x_contract_number
Integer
Users with multiple contracts must provide the contract number, for which all API requests are to be executed.
Retrieve a link with a JSON Web Token for accessing the server's Remote Console.
Examples
require'time'require'ionoscloud'# setup authorizationIonoscloud.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'endapi_instance =Ionoscloud::ServersApi.newdatacenter_id ='datacenter_id_example'# String | The unique ID of the data center.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, for which all API requests are to be executed.
}begin# Get Remote Console link result = api_instance.datacenters_servers_remote_console_get(datacenter_id, server_id, opts)p resultrescueIonoscloud::ApiError=> eputs"Error when calling ServersApi->datacenters_servers_remote_console_get: #{e}"end
Using the datacenters_servers_remote_console_get_with_http_info variant
This returns an Array which contains the response data, status code and headers.
begin# 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 # => 2xxp headers # => { ... }p data # => <RemoteConsoleUrl>rescueIonoscloud::ApiError=> eputs"Error when calling ServersApi->datacenters_servers_remote_console_get_with_http_info: #{e}"end
Parameters
Name
Type
Description
Notes
datacenter_id
String
The unique ID of the data center.
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=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on
[optional][default to 0]
x_contract_number
Integer
Users with multiple contracts must provide the contract number, for which all API requests are to be executed.
Resumes a suspended Cube Server specified by its ID. Since the suspended instance was not deleted the allocated resources continue to be billed. You can perform this operation only for Cube Servers. To check the status of the request, you can use the 'Location' HTTP header in the response (see 'Requests' for more information).
Examples
require'time'require'ionoscloud'# setup authorizationIonoscloud.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'endapi_instance =Ionoscloud::ServersApi.newdatacenter_id ='datacenter_id_example'# String | The unique ID of the data center.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, for which all API requests are to be executed.
}begin# Resume a Cube Server by ID api_instance.datacenters_servers_resume_post(datacenter_id, server_id, opts)rescueIonoscloud::ApiError=> eputs"Error when calling ServersApi->datacenters_servers_resume_post: #{e}"end
Using the datacenters_servers_resume_post_with_http_info variant
This returns an Array which contains the response data (nil in this case), status code and headers.
begin# Resume a Cube Server by ID data, status_code, headers = api_instance.datacenters_servers_resume_post_with_http_info(datacenter_id, server_id, opts)
p status_code # => 2xxp headers # => { ... }p data # => nilrescueIonoscloud::ApiError=> eputs"Error when calling ServersApi->datacenters_servers_resume_post_with_http_info: #{e}"end
Parameters
Name
Type
Description
Notes
datacenter_id
String
The unique ID of the data center.
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=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on
[optional][default to 0]
x_contract_number
Integer
Users with multiple contracts must provide the contract number, for which all API requests are to be executed.
Starts the Enterprise Server specified by its ID. >Note that you cannot use this method to start a Cube Server. By starting the Enterprise Server, cores and RAM are provisioned, and the billing continues. If the server's public IPv4 address has been deallocated, a new IPv4 address will be assigned. IPv6 blocks and addresses will remain unchanged when stopping and starting a server. To check the status of the request, you can use the 'Location' HTTP header in the response (see 'Requests' for more information).
Examples
require'time'require'ionoscloud'# setup authorizationIonoscloud.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'endapi_instance =Ionoscloud::ServersApi.newdatacenter_id ='datacenter_id_example'# String | The unique ID of the data center.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, for which all API requests are to be executed.
}begin# Start an Enterprise Server by ID api_instance.datacenters_servers_start_post(datacenter_id, server_id, opts)rescueIonoscloud::ApiError=> eputs"Error when calling ServersApi->datacenters_servers_start_post: #{e}"end
Using the datacenters_servers_start_post_with_http_info variant
This returns an Array which contains the response data (nil in this case), status code and headers.
begin# Start an Enterprise Server by ID data, status_code, headers = api_instance.datacenters_servers_start_post_with_http_info(datacenter_id, server_id, opts)
p status_code # => 2xxp headers # => { ... }p data # => nilrescueIonoscloud::ApiError=> eputs"Error when calling ServersApi->datacenters_servers_start_post_with_http_info: #{e}"end
Parameters
Name
Type
Description
Notes
datacenter_id
String
The unique ID of the data center.
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=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on
[optional][default to 0]
x_contract_number
Integer
Users with multiple contracts must provide the contract number, for which all API requests are to be executed.
Stops the Enterprise Server specified by its ID. >Note that you cannot use this method to stop a Cube Server. By stopping the Enterprise Server, cores and RAM are freed and no longer charged. Public IPv4 IPs that are not reserved are returned to the IPv4 pool. IPv6 blocks and addresses will remain unchanged when stopping and starting a server. To check the status of the request, you can use the 'Location' HTTP header in the response (see 'Requests' for more information).
Examples
require'time'require'ionoscloud'# setup authorizationIonoscloud.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'endapi_instance =Ionoscloud::ServersApi.newdatacenter_id ='datacenter_id_example'# String | The unique ID of the data center.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, for which all API requests are to be executed.
}begin# Stop an Enterprise Server by ID api_instance.datacenters_servers_stop_post(datacenter_id, server_id, opts)rescueIonoscloud::ApiError=> eputs"Error when calling ServersApi->datacenters_servers_stop_post: #{e}"end
Using the datacenters_servers_stop_post_with_http_info variant
This returns an Array which contains the response data (nil in this case), status code and headers.
begin# Stop an Enterprise Server by ID data, status_code, headers = api_instance.datacenters_servers_stop_post_with_http_info(datacenter_id, server_id, opts)
p status_code # => 2xxp headers # => { ... }p data # => nilrescueIonoscloud::ApiError=> eputs"Error when calling ServersApi->datacenters_servers_stop_post_with_http_info: #{e}"end
Parameters
Name
Type
Description
Notes
datacenter_id
String
The unique ID of the data center.
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=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on
[optional][default to 0]
x_contract_number
Integer
Users with multiple contracts must provide the contract number, for which all API requests are to be executed.
Suspends the specified Cubes instance within the data center. The instance is not deleted and allocated resources continue to be billed. You can perform this operation only for Cube Servers. To check the status of the request, you can use the 'Location' HTTP header in the response (see 'Requests' for more information).
Examples
require'time'require'ionoscloud'# setup authorizationIonoscloud.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'endapi_instance =Ionoscloud::ServersApi.newdatacenter_id ='datacenter_id_example'# String | The unique ID of the data center.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, for which all API requests are to be executed.
}begin# Suspend a Cube Server by ID api_instance.datacenters_servers_suspend_post(datacenter_id, server_id, opts)rescueIonoscloud::ApiError=> eputs"Error when calling ServersApi->datacenters_servers_suspend_post: #{e}"end
Using the datacenters_servers_suspend_post_with_http_info variant
This returns an Array which contains the response data (nil in this case), status code and headers.
begin# Suspend a Cube Server by ID data, status_code, headers = api_instance.datacenters_servers_suspend_post_with_http_info(datacenter_id, server_id, opts)
p status_code # => 2xxp headers # => { ... }p data # => nilrescueIonoscloud::ApiError=> eputs"Error when calling ServersApi->datacenters_servers_suspend_post_with_http_info: #{e}"end
Parameters
Name
Type
Description
Notes
datacenter_id
String
The unique ID of the data center.
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=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on
[optional][default to 0]
x_contract_number
Integer
Users with multiple contracts must provide the contract number, for which all API requests are to be executed.
Retrieve a JSON Web Token from the server for use in login operations (such as accessing the server's console).
Examples
require'time'require'ionoscloud'# setup authorizationIonoscloud.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'endapi_instance =Ionoscloud::ServersApi.newdatacenter_id ='datacenter_id_example'# String | The unique ID of the data center.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, for which all API requests are to be executed.
}begin# Get JASON Web Token result = api_instance.datacenters_servers_token_get(datacenter_id, server_id, opts)p resultrescueIonoscloud::ApiError=> eputs"Error when calling ServersApi->datacenters_servers_token_get: #{e}"end
Using the datacenters_servers_token_get_with_http_info variant
This returns an Array which contains the response data, status code and headers.
begin# 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 # => 2xxp headers # => { ... }p data # => <Token>rescueIonoscloud::ApiError=> eputs"Error when calling ServersApi->datacenters_servers_token_get_with_http_info: #{e}"end
Parameters
Name
Type
Description
Notes
datacenter_id
String
The unique ID of the data center.
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=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on
[optional][default to 0]
x_contract_number
Integer
Users with multiple contracts must provide the contract number, for which all API requests are to be executed.
require'time'require'ionoscloud'# setup authorizationIonoscloud.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'endapi_instance =Ionoscloud::ServersApi.newdatacenter_id ='datacenter_id_example'# String | The unique ID of the data center.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, for which all API requests are to be executed.
}begin# Upgrade a Server by ID api_instance.datacenters_servers_upgrade_post(datacenter_id, server_id, opts)rescueIonoscloud::ApiError=> eputs"Error when calling ServersApi->datacenters_servers_upgrade_post: #{e}"end
Using the datacenters_servers_upgrade_post_with_http_info variant
This returns an Array which contains the response data (nil in this case), status code and headers.
begin# Upgrade a Server by ID data, status_code, headers = api_instance.datacenters_servers_upgrade_post_with_http_info(datacenter_id, server_id, opts)
p status_code # => 2xxp headers # => { ... }p data # => nilrescueIonoscloud::ApiError=> eputs"Error when calling ServersApi->datacenters_servers_upgrade_post_with_http_info: #{e}"end
Parameters
Name
Type
Description
Notes
datacenter_id
String
The unique ID of the data center.
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=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on
[optional][default to 0]
x_contract_number
Integer
Users with multiple contracts must provide the contract number, for which all API requests are to be executed.
Detachs the specified volume from the server. Note that only the volume's connection to the specified server is disconnected. If you want to delete the volume, you must submit a separate request to perform the deletion.
Examples
require'time'require'ionoscloud'# setup authorizationIonoscloud.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'endapi_instance =Ionoscloud::ServersApi.newdatacenter_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.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, for which all API requests are to be executed.
}begin# Detach a Volume by ID api_instance.datacenters_servers_volumes_delete(datacenter_id, server_id, volume_id, opts)rescueIonoscloud::ApiError=> eputs"Error when calling ServersApi->datacenters_servers_volumes_delete: #{e}"end
Using the datacenters_servers_volumes_delete_with_http_info variant
This returns an Array which contains the response data (nil in this case), status code and headers.
begin# Detach a Volume by ID data, status_code, headers = api_instance.datacenters_servers_volumes_delete_with_http_info(datacenter_id, server_id, volume_id, opts)
p status_code # => 2xxp headers # => { ... }p data # => nilrescueIonoscloud::ApiError=> eputs"Error when calling ServersApi->datacenters_servers_volumes_delete_with_http_info: #{e}"end
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.
pretty
Boolean
Controls whether the response is pretty-printed (with indentations and new lines).
[optional][default to true]
depth
Integer
Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on
[optional][default to 0]
x_contract_number
Integer
Users with multiple contracts must provide the contract number, for which all API requests are to be executed.
Retrieves the properties of the volume attached to the specified server.
Examples
require'time'require'ionoscloud'# setup authorizationIonoscloud.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'endapi_instance =Ionoscloud::ServersApi.newdatacenter_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.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, for which all API requests are to be executed.
}begin# Get Attached Volume by ID result = api_instance.datacenters_servers_volumes_find_by_id(datacenter_id, server_id, volume_id, opts)p resultrescueIonoscloud::ApiError=> eputs"Error when calling ServersApi->datacenters_servers_volumes_find_by_id: #{e}"end
Using the datacenters_servers_volumes_find_by_id_with_http_info variant
This returns an Array which contains the response data, status code and headers.
begin# Get Attached Volume by ID 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 # => 2xxp headers # => { ... }p data # => <Volume>rescueIonoscloud::ApiError=> eputs"Error when calling ServersApi->datacenters_servers_volumes_find_by_id_with_http_info: #{e}"end
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.
pretty
Boolean
Controls whether the response is pretty-printed (with indentations and new lines).
[optional][default to true]
depth
Integer
Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on
[optional][default to 0]
x_contract_number
Integer
Users with multiple contracts must provide the contract number, for which all API requests are to be executed.
Lists all volumes attached to the specified server.
Examples
require'time'require'ionoscloud'# setup authorizationIonoscloud.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'endapi_instance =Ionoscloud::ServersApi.newdatacenter_id ='datacenter_id_example'# String | The unique ID of the data center.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, for 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 (used together with <b><i>limit</i></b> for pagination).
limit: 56# Integer | The maximum number of elements to return (use together with offset for pagination).}begin# Get Attached Volumes result = api_instance.datacenters_servers_volumes_get(datacenter_id, server_id, opts)p resultrescueIonoscloud::ApiError=> eputs"Error when calling ServersApi->datacenters_servers_volumes_get: #{e}"end
Using the datacenters_servers_volumes_get_with_http_info variant
This returns an Array which contains the response data, status code and headers.
begin# Get Attached Volumes data, status_code, headers = api_instance.datacenters_servers_volumes_get_with_http_info(datacenter_id, server_id, opts)
p status_code # => 2xxp headers # => { ... }p data # => <AttachedVolumes>rescueIonoscloud::ApiError=> eputs"Error when calling ServersApi->datacenters_servers_volumes_get_with_http_info: #{e}"end
Parameters
Name
Type
Description
Notes
datacenter_id
String
The unique ID of the data center.
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=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on
[optional][default to 0]
x_contract_number
Integer
Users with multiple contracts must provide the contract number, for 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 (used together with <b><i>limit</i></b> for pagination).
[optional][default to 0]
limit
Integer
The maximum number of elements to return (use together with offset for pagination).
Attachs an existing storage volume to the specified server. You can attach an existing volume in the VDC to a server. To move a volume from one server to another, you must first detach the volume from the first server and attach it to the second server. It is also possible to create and attach a volume in one step by simply providing a new volume description as a payload. The only difference is the URL; see 'Creating a Volume' for details about volumes. Note that the combined total of attached volumes and NICs cannot exceed 24 per server.
Examples
require'time'require'ionoscloud'# setup authorizationIonoscloud.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'endapi_instance =Ionoscloud::ServersApi.newdatacenter_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 | 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, for which all API requests are to be executed.
}begin# Attach a Volume to a Server result = api_instance.datacenters_servers_volumes_post(datacenter_id, server_id, volume, opts)p resultrescueIonoscloud::ApiError=> eputs"Error when calling ServersApi->datacenters_servers_volumes_post: #{e}"end
Using the datacenters_servers_volumes_post_with_http_info variant
This returns an Array which contains the response data, status code and headers.
begin# Attach a Volume to a Server data, status_code, headers = api_instance.datacenters_servers_volumes_post_with_http_info(datacenter_id, server_id, volume, opts)
p status_code # => 2xxp headers # => { ... }p data # => <Volume>rescueIonoscloud::ApiError=> eputs"Error when calling ServersApi->datacenters_servers_volumes_post_with_http_info: #{e}"end
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=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on
[optional][default to 0]
x_contract_number
Integer
Users with multiple contracts must provide the contract number, for which all API requests are to be executed.
