# NetworkInterfacesApi All URIs are relative to ** | Method | HTTP request | Description | | ------------------------------------------------------------------------------------ | ---------------------------------------------------------------------- | --------------------- | | [**datacenters\_servers\_nics\_delete**](#datacenters_servers_nics_delete) | **DELETE** /datacenters/{datacenterId}/servers/{serverId}/nics/{nicId} | Delete NICs | | [**datacenters\_servers\_nics\_find\_by\_id**](#datacenters_servers_nics_find_by_id) | **GET** /datacenters/{datacenterId}/servers/{serverId}/nics/{nicId} | Retrieve NICs | | [**datacenters\_servers\_nics\_get**](#datacenters_servers_nics_get) | **GET** /datacenters/{datacenterId}/servers/{serverId}/nics | List NICs | | [**datacenters\_servers\_nics\_patch**](#datacenters_servers_nics_patch) | **PATCH** /datacenters/{datacenterId}/servers/{serverId}/nics/{nicId} | Partially modify NICs | | [**datacenters\_servers\_nics\_post**](#datacenters_servers_nics_post) | **POST** /datacenters/{datacenterId}/servers/{serverId}/nics | Create a NIC | | [**datacenters\_servers\_nics\_put**](#datacenters_servers_nics_put) | **PUT** /datacenters/{datacenterId}/servers/{serverId}/nics/{nicId} | Modify NICs | ## datacenters\_servers\_nics\_delete > datacenters\_servers\_nics\_delete(datacenter\_id, server\_id, nic\_id, opts) Delete NICs Remove the specified NIC. ### Examples ```ruby require 'time' require 'ionoscloud' # setup authorization Ionoscloud.configure do |config| # Configure HTTP basic authorization: Basic Authentication config.username = 'YOUR USERNAME' config.password = 'YOUR PASSWORD' # Configure API key authorization: Token Authentication config.api_key['Authorization'] = 'YOUR API KEY' # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) # config.api_key_prefix['Authorization'] = 'Bearer' end api_instance = Ionoscloud::NetworkInterfacesApi.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. nic_id = 'nic_id_example' # String | The unique ID of the NIC. 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 # Delete NICs api_instance.datacenters_servers_nics_delete(datacenter_id, server_id, nic_id, opts) rescue Ionoscloud::ApiError => e puts "Error when calling NetworkInterfacesApi->datacenters_servers_nics_delete: #{e}" end ``` #### Using the datacenters\_servers\_nics\_delete\_with\_http\_info variant This returns an Array which contains the response data (`nil` in this case), status code and headers. > \ datacenters\_servers\_nics\_delete\_with\_http\_info(datacenter\_id, server\_id, nic\_id, opts) ```ruby begin # Delete NICs data, status_code, headers = api_instance.datacenters_servers_nics_delete_with_http_info(datacenter_id, server_id, nic_id, opts) p status_code # => 2xx p headers # => { ... } p data # => nil rescue Ionoscloud::ApiError => e puts "Error when calling NetworkInterfacesApi->datacenters_servers_nics_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. | | | **nic\_id** | **String** | The unique ID of the NIC. | | | **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] | ### Return type nil (empty response body) ### Authorization Basic Authentication, Token Authentication ### HTTP request headers * **Content-Type**: Not defined * **Accept**: application/json ## datacenters\_servers\_nics\_find\_by\_id > datacenters\_servers\_nics\_find\_by\_id(datacenter\_id, server\_id, nic\_id, opts) Retrieve NICs Retrieve the properties of the specified NIC. ### Examples ```ruby require 'time' require 'ionoscloud' # setup authorization Ionoscloud.configure do |config| # Configure HTTP basic authorization: Basic Authentication config.username = 'YOUR USERNAME' config.password = 'YOUR PASSWORD' # Configure API key authorization: Token Authentication config.api_key['Authorization'] = 'YOUR API KEY' # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) # config.api_key_prefix['Authorization'] = 'Bearer' end api_instance = Ionoscloud::NetworkInterfacesApi.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. nic_id = 'nic_id_example' # String | The unique ID of the NIC. 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 NICs result = api_instance.datacenters_servers_nics_find_by_id(datacenter_id, server_id, nic_id, opts) p result rescue Ionoscloud::ApiError => e puts "Error when calling NetworkInterfacesApi->datacenters_servers_nics_find_by_id: #{e}" end ``` #### Using the datacenters\_servers\_nics\_find\_by\_id\_with\_http\_info variant This returns an Array which contains the response data, status code and headers. > \ datacenters\_servers\_nics\_find\_by\_id\_with\_http\_info(datacenter\_id, server\_id, nic\_id, opts) ```ruby begin # Retrieve NICs data, status_code, headers = api_instance.datacenters_servers_nics_find_by_id_with_http_info(datacenter_id, server_id, nic_id, opts) p status_code # => 2xx p headers # => { ... } p data # => rescue Ionoscloud::ApiError => e puts "Error when calling NetworkInterfacesApi->datacenters_servers_nics_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. | | | **nic\_id** | **String** | The unique ID of the NIC. | | | **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] | ### Return type [**Nic**](https://docs.ionos.com/sections-test/ruby-sdk/cloud-api-ruby-sdk/models/nic) ### Authorization Basic Authentication, Token Authentication ### HTTP request headers * **Content-Type**: Not defined * **Accept**: application/json ## datacenters\_servers\_nics\_get > datacenters\_servers\_nics\_get(datacenter\_id, server\_id, opts) List NICs List all NICs, attached to the specified server. ### Examples ```ruby require 'time' require 'ionoscloud' # setup authorization Ionoscloud.configure do |config| # Configure HTTP basic authorization: Basic Authentication config.username = 'YOUR USERNAME' config.password = 'YOUR PASSWORD' # Configure API key authorization: Token Authentication config.api_key['Authorization'] = 'YOUR API KEY' # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) # config.api_key_prefix['Authorization'] = 'Bearer' end api_instance = Ionoscloud::NetworkInterfacesApi.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. 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 limit for pagination). limit: 56 # Integer | The maximum number of elements to return (use together with offset for pagination). } begin # List NICs result = api_instance.datacenters_servers_nics_get(datacenter_id, server_id, opts) p result rescue Ionoscloud::ApiError => e puts "Error when calling NetworkInterfacesApi->datacenters_servers_nics_get: #{e}" end ``` #### Using the datacenters\_servers\_nics\_get\_with\_http\_info variant This returns an Array which contains the response data, status code and headers. > \ datacenters\_servers\_nics\_get\_with\_http\_info(datacenter\_id, server\_id, opts) ```ruby begin # List NICs data, status_code, headers = api_instance.datacenters_servers_nics_get_with_http_info(datacenter_id, server_id, opts) p status_code # => 2xx p headers # => { ... } p data # => rescue Ionoscloud::ApiError => e puts "Error when calling NetworkInterfacesApi->datacenters_servers_nics_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 \\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 [**Nics**](https://docs.ionos.com/sections-test/ruby-sdk/cloud-api-ruby-sdk/models/nics) ### Authorization Basic Authentication, Token Authentication ### HTTP request headers * **Content-Type**: Not defined * **Accept**: application/json ## datacenters\_servers\_nics\_patch > datacenters\_servers\_nics\_patch(datacenter\_id, server\_id, nic\_id, nic, opts) Partially modify NICs Update the properties of the specified NIC. ### Examples ```ruby require 'time' require 'ionoscloud' # setup authorization Ionoscloud.configure do |config| # Configure HTTP basic authorization: Basic Authentication config.username = 'YOUR USERNAME' config.password = 'YOUR PASSWORD' # Configure API key authorization: Token Authentication config.api_key['Authorization'] = 'YOUR API KEY' # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) # config.api_key_prefix['Authorization'] = 'Bearer' end api_instance = Ionoscloud::NetworkInterfacesApi.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. nic_id = 'nic_id_example' # String | The unique ID of the NIC. nic = Ionoscloud::NicProperties.new({lan: 2}) # NicProperties | The properties of the NIC 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 NICs result = api_instance.datacenters_servers_nics_patch(datacenter_id, server_id, nic_id, nic, opts) p result rescue Ionoscloud::ApiError => e puts "Error when calling NetworkInterfacesApi->datacenters_servers_nics_patch: #{e}" end ``` #### Using the datacenters\_servers\_nics\_patch\_with\_http\_info variant This returns an Array which contains the response data, status code and headers. > \ datacenters\_servers\_nics\_patch\_with\_http\_info(datacenter\_id, server\_id, nic\_id, nic, opts) ```ruby begin # Partially modify NICs data, status_code, headers = api_instance.datacenters_servers_nics_patch_with_http_info(datacenter_id, server_id, nic_id, nic, opts) p status_code # => 2xx p headers # => { ... } p data # => rescue Ionoscloud::ApiError => e puts "Error when calling NetworkInterfacesApi->datacenters_servers_nics_patch_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. | | | **nic\_id** | **String** | The unique ID of the NIC. | | | **nic** | [**NicProperties**](https://docs.ionos.com/sections-test/ruby-sdk/cloud-api-ruby-sdk/models/nicproperties) | The properties of the NIC to be updated. | | | **pretty** | **Boolean** | Controls whether the response is pretty-printed (with indentations and new lines). | \[optional]\[default to true] | | **depth** | **Integer** | Controls the detail depth of the response objects. GET /datacenters/\[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on | \[optional]\[default to 0] | | **x\_contract\_number** | **Integer** | Users with multiple contracts must provide the contract number, for which all API requests are to be executed. | \[optional] | ### Return type [**Nic**](https://docs.ionos.com/sections-test/ruby-sdk/cloud-api-ruby-sdk/models/nic) ### Authorization Basic Authentication, Token Authentication ### HTTP request headers * **Content-Type**: application/json * **Accept**: application/json ## datacenters\_servers\_nics\_post > datacenters\_servers\_nics\_post(datacenter\_id, server\_id, nic, opts) Create a NIC Adds a NIC to the specified server. The combined total of NICs and attached volumes cannot exceed 24 per server. ### Examples ```ruby require 'time' require 'ionoscloud' # setup authorization Ionoscloud.configure do |config| # Configure HTTP basic authorization: Basic Authentication config.username = 'YOUR USERNAME' config.password = 'YOUR PASSWORD' # Configure API key authorization: Token Authentication config.api_key['Authorization'] = 'YOUR API KEY' # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) # config.api_key_prefix['Authorization'] = 'Bearer' end api_instance = Ionoscloud::NetworkInterfacesApi.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. nic = Ionoscloud::Nic.new({properties: Ionoscloud::NicProperties.new({lan: 2})}) # Nic | The NIC 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 NIC result = api_instance.datacenters_servers_nics_post(datacenter_id, server_id, nic, opts) p result rescue Ionoscloud::ApiError => e puts "Error when calling NetworkInterfacesApi->datacenters_servers_nics_post: #{e}" end ``` #### Using the datacenters\_servers\_nics\_post\_with\_http\_info variant This returns an Array which contains the response data, status code and headers. > \ datacenters\_servers\_nics\_post\_with\_http\_info(datacenter\_id, server\_id, nic, opts) ```ruby begin # Create a NIC data, status_code, headers = api_instance.datacenters_servers_nics_post_with_http_info(datacenter_id, server_id, nic, opts) p status_code # => 2xx p headers # => { ... } p data # => rescue Ionoscloud::ApiError => e puts "Error when calling NetworkInterfacesApi->datacenters_servers_nics_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. | | | **nic** | [**Nic**](https://docs.ionos.com/sections-test/ruby-sdk/cloud-api-ruby-sdk/models/nic) | The NIC 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=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] | ### Return type [**Nic**](https://docs.ionos.com/sections-test/ruby-sdk/cloud-api-ruby-sdk/models/nic) ### Authorization Basic Authentication, Token Authentication ### HTTP request headers * **Content-Type**: application/json * **Accept**: application/json ## datacenters\_servers\_nics\_put > datacenters\_servers\_nics\_put(datacenter\_id, server\_id, nic\_id, nic, opts) Modify NICs Modify the properties of the specified NIC. ### Examples ```ruby require 'time' require 'ionoscloud' # setup authorization Ionoscloud.configure do |config| # Configure HTTP basic authorization: Basic Authentication config.username = 'YOUR USERNAME' config.password = 'YOUR PASSWORD' # Configure API key authorization: Token Authentication config.api_key['Authorization'] = 'YOUR API KEY' # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) # config.api_key_prefix['Authorization'] = 'Bearer' end api_instance = Ionoscloud::NetworkInterfacesApi.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. nic_id = 'nic_id_example' # String | The unique ID of the NIC. nic = Ionoscloud::NicPut.new({properties: Ionoscloud::NicProperties.new({lan: 2})}) # NicPut | The modified NIC 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 # Modify NICs result = api_instance.datacenters_servers_nics_put(datacenter_id, server_id, nic_id, nic, opts) p result rescue Ionoscloud::ApiError => e puts "Error when calling NetworkInterfacesApi->datacenters_servers_nics_put: #{e}" end ``` #### Using the datacenters\_servers\_nics\_put\_with\_http\_info variant This returns an Array which contains the response data, status code and headers. > \ datacenters\_servers\_nics\_put\_with\_http\_info(datacenter\_id, server\_id, nic\_id, nic, opts) ```ruby begin # Modify NICs data, status_code, headers = api_instance.datacenters_servers_nics_put_with_http_info(datacenter_id, server_id, nic_id, nic, opts) p status_code # => 2xx p headers # => { ... } p data # => rescue Ionoscloud::ApiError => e puts "Error when calling NetworkInterfacesApi->datacenters_servers_nics_put_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. | | | **nic\_id** | **String** | The unique ID of the NIC. | | | **nic** | [**NicPut**](https://docs.ionos.com/sections-test/ruby-sdk/cloud-api-ruby-sdk/models/nicput) | The modified NIC | | | **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] | ### Return type [**Nic**](https://docs.ionos.com/sections-test/ruby-sdk/cloud-api-ruby-sdk/models/nic) ### Authorization Basic Authentication, Token Authentication ### HTTP request headers * **Content-Type**: application/json * **Accept**: application/json