docs/api/NATGatewaysApi.md in ionoscloud-6.0.0.beta.4 vs docs/api/NATGatewaysApi.md in ionoscloud-6.0.0
- old
+ new
@@ -2,37 +2,37 @@
All URIs are relative to *https://api.ionos.com/cloudapi/v6*
| Method | HTTP request | Description |
| ------ | ------------ | ----------- |
-| [**datacenters_natgateways_delete**](NATGatewaysApi.md#datacenters_natgateways_delete) | **DELETE** /datacenters/{datacenterId}/natgateways/{natGatewayId} | Remove a NAT gateway |
-| [**datacenters_natgateways_find_by_nat_gateway_id**](NATGatewaysApi.md#datacenters_natgateways_find_by_nat_gateway_id) | **GET** /datacenters/{datacenterId}/natgateways/{natGatewayId} | Retrieve a NAT gateway |
-| [**datacenters_natgateways_flowlogs_delete**](NATGatewaysApi.md#datacenters_natgateways_flowlogs_delete) | **DELETE** /datacenters/{datacenterId}/natgateways/{natGatewayId}/flowlogs/{flowLogId} | Remove Flow Log from NAT Gateway |
-| [**datacenters_natgateways_flowlogs_find_by_flow_log_id**](NATGatewaysApi.md#datacenters_natgateways_flowlogs_find_by_flow_log_id) | **GET** /datacenters/{datacenterId}/natgateways/{natGatewayId}/flowlogs/{flowLogId} | Retrieve a Flow Log of the NAT Gateway |
+| [**datacenters_natgateways_delete**](NATGatewaysApi.md#datacenters_natgateways_delete) | **DELETE** /datacenters/{datacenterId}/natgateways/{natGatewayId} | Delete NAT Gateways |
+| [**datacenters_natgateways_find_by_nat_gateway_id**](NATGatewaysApi.md#datacenters_natgateways_find_by_nat_gateway_id) | **GET** /datacenters/{datacenterId}/natgateways/{natGatewayId} | Retrieve NAT Gateways |
+| [**datacenters_natgateways_flowlogs_delete**](NATGatewaysApi.md#datacenters_natgateways_flowlogs_delete) | **DELETE** /datacenters/{datacenterId}/natgateways/{natGatewayId}/flowlogs/{flowLogId} | Delete NAT Gateway Flow Logs |
+| [**datacenters_natgateways_flowlogs_find_by_flow_log_id**](NATGatewaysApi.md#datacenters_natgateways_flowlogs_find_by_flow_log_id) | **GET** /datacenters/{datacenterId}/natgateways/{natGatewayId}/flowlogs/{flowLogId} | Retrieve NAT Gateway Flow Logs |
| [**datacenters_natgateways_flowlogs_get**](NATGatewaysApi.md#datacenters_natgateways_flowlogs_get) | **GET** /datacenters/{datacenterId}/natgateways/{natGatewayId}/flowlogs | List NAT Gateway Flow Logs |
-| [**datacenters_natgateways_flowlogs_patch**](NATGatewaysApi.md#datacenters_natgateways_flowlogs_patch) | **PATCH** /datacenters/{datacenterId}/natgateways/{natGatewayId}/flowlogs/{flowLogId} | Partially modify a Flow Log of the NAT Gateway |
-| [**datacenters_natgateways_flowlogs_post**](NATGatewaysApi.md#datacenters_natgateways_flowlogs_post) | **POST** /datacenters/{datacenterId}/natgateways/{natGatewayId}/flowlogs | Add a NAT Gateways Flow Log |
-| [**datacenters_natgateways_flowlogs_put**](NATGatewaysApi.md#datacenters_natgateways_flowlogs_put) | **PUT** /datacenters/{datacenterId}/natgateways/{natGatewayId}/flowlogs/{flowLogId} | Modify a Flow Log of the NAT Gateway |
+| [**datacenters_natgateways_flowlogs_patch**](NATGatewaysApi.md#datacenters_natgateways_flowlogs_patch) | **PATCH** /datacenters/{datacenterId}/natgateways/{natGatewayId}/flowlogs/{flowLogId} | Partially modify NAT Gateway Flow Logs |
+| [**datacenters_natgateways_flowlogs_post**](NATGatewaysApi.md#datacenters_natgateways_flowlogs_post) | **POST** /datacenters/{datacenterId}/natgateways/{natGatewayId}/flowlogs | Create NAT Gateway Flow Logs |
+| [**datacenters_natgateways_flowlogs_put**](NATGatewaysApi.md#datacenters_natgateways_flowlogs_put) | **PUT** /datacenters/{datacenterId}/natgateways/{natGatewayId}/flowlogs/{flowLogId} | Modify NAT Gateway Flow Logs |
| [**datacenters_natgateways_get**](NATGatewaysApi.md#datacenters_natgateways_get) | **GET** /datacenters/{datacenterId}/natgateways | List NAT Gateways |
-| [**datacenters_natgateways_patch**](NATGatewaysApi.md#datacenters_natgateways_patch) | **PATCH** /datacenters/{datacenterId}/natgateways/{natGatewayId} | Partially update a NAT gateway |
-| [**datacenters_natgateways_post**](NATGatewaysApi.md#datacenters_natgateways_post) | **POST** /datacenters/{datacenterId}/natgateways | Create a NAT Gateway |
-| [**datacenters_natgateways_put**](NATGatewaysApi.md#datacenters_natgateways_put) | **PUT** /datacenters/{datacenterId}/natgateways/{natGatewayId} | Update a NAT gateway |
-| [**datacenters_natgateways_rules_delete**](NATGatewaysApi.md#datacenters_natgateways_rules_delete) | **DELETE** /datacenters/{datacenterId}/natgateways/{natGatewayId}/rules/{natGatewayRuleId} | Remove rule from NAT Gateway |
-| [**datacenters_natgateways_rules_find_by_nat_gateway_rule_id**](NATGatewaysApi.md#datacenters_natgateways_rules_find_by_nat_gateway_rule_id) | **GET** /datacenters/{datacenterId}/natgateways/{natGatewayId}/rules/{natGatewayRuleId} | Retrieve a NAT Gateway Rule |
-| [**datacenters_natgateways_rules_get**](NATGatewaysApi.md#datacenters_natgateways_rules_get) | **GET** /datacenters/{datacenterId}/natgateways/{natGatewayId}/rules | List NAT Gateways Rules |
-| [**datacenters_natgateways_rules_patch**](NATGatewaysApi.md#datacenters_natgateways_rules_patch) | **PATCH** /datacenters/{datacenterId}/natgateways/{natGatewayId}/rules/{natGatewayRuleId} | Partially modify a rule of the NAT gateway |
-| [**datacenters_natgateways_rules_post**](NATGatewaysApi.md#datacenters_natgateways_rules_post) | **POST** /datacenters/{datacenterId}/natgateways/{natGatewayId}/rules | Create a NAT Gateway Rule |
-| [**datacenters_natgateways_rules_put**](NATGatewaysApi.md#datacenters_natgateways_rules_put) | **PUT** /datacenters/{datacenterId}/natgateways/{natGatewayId}/rules/{natGatewayRuleId} | Modify a rule of the NAT gateway |
+| [**datacenters_natgateways_patch**](NATGatewaysApi.md#datacenters_natgateways_patch) | **PATCH** /datacenters/{datacenterId}/natgateways/{natGatewayId} | Partially modify NAT Gateways |
+| [**datacenters_natgateways_post**](NATGatewaysApi.md#datacenters_natgateways_post) | **POST** /datacenters/{datacenterId}/natgateways | Create NAT Gateways |
+| [**datacenters_natgateways_put**](NATGatewaysApi.md#datacenters_natgateways_put) | **PUT** /datacenters/{datacenterId}/natgateways/{natGatewayId} | Modify NAT Gateways |
+| [**datacenters_natgateways_rules_delete**](NATGatewaysApi.md#datacenters_natgateways_rules_delete) | **DELETE** /datacenters/{datacenterId}/natgateways/{natGatewayId}/rules/{natGatewayRuleId} | Delete NAT Gateway rules |
+| [**datacenters_natgateways_rules_find_by_nat_gateway_rule_id**](NATGatewaysApi.md#datacenters_natgateways_rules_find_by_nat_gateway_rule_id) | **GET** /datacenters/{datacenterId}/natgateways/{natGatewayId}/rules/{natGatewayRuleId} | Retrieve NAT Gateway rules |
+| [**datacenters_natgateways_rules_get**](NATGatewaysApi.md#datacenters_natgateways_rules_get) | **GET** /datacenters/{datacenterId}/natgateways/{natGatewayId}/rules | List NAT Gateway rules |
+| [**datacenters_natgateways_rules_patch**](NATGatewaysApi.md#datacenters_natgateways_rules_patch) | **PATCH** /datacenters/{datacenterId}/natgateways/{natGatewayId}/rules/{natGatewayRuleId} | Partially modify NAT Gateway rules |
+| [**datacenters_natgateways_rules_post**](NATGatewaysApi.md#datacenters_natgateways_rules_post) | **POST** /datacenters/{datacenterId}/natgateways/{natGatewayId}/rules | Create NAT Gateway rules |
+| [**datacenters_natgateways_rules_put**](NATGatewaysApi.md#datacenters_natgateways_rules_put) | **PUT** /datacenters/{datacenterId}/natgateways/{natGatewayId}/rules/{natGatewayRuleId} | Modify NAT Gateway rules |
## datacenters_natgateways_delete
> datacenters_natgateways_delete(datacenter_id, nat_gateway_id, opts)
-Remove a NAT gateway
+Delete NAT Gateways
-Removes the specified NAT gateway.
+Remove the specified NAT Gateway from the data center.
### Examples
```ruby
require 'time'
@@ -49,19 +49,19 @@
# config.api_key_prefix['Authorization'] = 'Bearer'
end
api_instance = Ionoscloud::NATGatewaysApi.new
datacenter_id = 'datacenter_id_example' # String | The unique ID of the data center.
-nat_gateway_id = 'nat_gateway_id_example' # String | The unique ID of the NAT gateway
+nat_gateway_id = 'nat_gateway_id_example' # String | The unique ID of the NAT Gateway.
opts = {
pretty: true, # Boolean | Controls whether the response is pretty-printed (with indentations and new lines).
depth: 56, # Integer | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on
x_contract_number: 56 # Integer | Users with multiple contracts must provide the contract number, against which all API requests are to be executed.
}
begin
- # Remove a NAT gateway
+ # Delete NAT Gateways
api_instance.datacenters_natgateways_delete(datacenter_id, nat_gateway_id, opts)
rescue Ionoscloud::ApiError => e
puts "Error when calling NATGatewaysApi->datacenters_natgateways_delete: #{e}"
end
```
@@ -72,11 +72,11 @@
> <Array(nil, Integer, Hash)> datacenters_natgateways_delete_with_http_info(datacenter_id, nat_gateway_id, opts)
```ruby
begin
- # Remove a NAT gateway
+ # Delete NAT Gateways
data, status_code, headers = api_instance.datacenters_natgateways_delete_with_http_info(datacenter_id, nat_gateway_id, opts)
p status_code # => 2xx
p headers # => { ... }
p data # => nil
rescue Ionoscloud::ApiError => e
@@ -87,11 +87,11 @@
### Parameters
| Name | Type | Description | Notes |
| ---- | ---- | ----------- | ----- |
| **datacenter_id** | **String** | The unique ID of the data center. | |
-| **nat_gateway_id** | **String** | The unique ID of the NAT gateway | |
+| **nat_gateway_id** | **String** | The unique ID of the NAT Gateway. | |
| **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, against which all API requests are to be executed. | [optional] |
### Return type
@@ -110,13 +110,13 @@
## datacenters_natgateways_find_by_nat_gateway_id
> <NatGateway> datacenters_natgateways_find_by_nat_gateway_id(datacenter_id, nat_gateway_id, opts)
-Retrieve a NAT gateway
+Retrieve NAT Gateways
-Retrieves the attributes of a given NAT gateway.
+Retrieve the properties of the specified NAT Gateway within the data center.
### Examples
```ruby
require 'time'
@@ -133,19 +133,19 @@
# config.api_key_prefix['Authorization'] = 'Bearer'
end
api_instance = Ionoscloud::NATGatewaysApi.new
datacenter_id = 'datacenter_id_example' # String | The unique ID of the data center.
-nat_gateway_id = 'nat_gateway_id_example' # String | The unique ID of the NAT gateway
+nat_gateway_id = 'nat_gateway_id_example' # String | The unique ID of the NAT Gateway.
opts = {
pretty: true, # Boolean | Controls whether the response is pretty-printed (with indentations and new lines).
depth: 56, # Integer | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on
x_contract_number: 56 # Integer | Users with multiple contracts must provide the contract number, against which all API requests are to be executed.
}
begin
- # Retrieve a NAT gateway
+ # Retrieve NAT Gateways
result = api_instance.datacenters_natgateways_find_by_nat_gateway_id(datacenter_id, nat_gateway_id, opts)
p result
rescue Ionoscloud::ApiError => e
puts "Error when calling NATGatewaysApi->datacenters_natgateways_find_by_nat_gateway_id: #{e}"
end
@@ -157,11 +157,11 @@
> <Array(<NatGateway>, Integer, Hash)> datacenters_natgateways_find_by_nat_gateway_id_with_http_info(datacenter_id, nat_gateway_id, opts)
```ruby
begin
- # Retrieve a NAT gateway
+ # Retrieve NAT Gateways
data, status_code, headers = api_instance.datacenters_natgateways_find_by_nat_gateway_id_with_http_info(datacenter_id, nat_gateway_id, opts)
p status_code # => 2xx
p headers # => { ... }
p data # => <NatGateway>
rescue Ionoscloud::ApiError => e
@@ -172,18 +172,18 @@
### Parameters
| Name | Type | Description | Notes |
| ---- | ---- | ----------- | ----- |
| **datacenter_id** | **String** | The unique ID of the data center. | |
-| **nat_gateway_id** | **String** | The unique ID of the NAT gateway | |
+| **nat_gateway_id** | **String** | The unique ID of the NAT Gateway. | |
| **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, against which all API requests are to be executed. | [optional] |
### Return type
-[**NatGateway**](NatGateway.md)
+[**NatGateway**](../models/NatGateway.md)
### Authorization
Basic Authentication, Token Authentication
@@ -195,13 +195,13 @@
## datacenters_natgateways_flowlogs_delete
> datacenters_natgateways_flowlogs_delete(datacenter_id, nat_gateway_id, flow_log_id, opts)
-Remove Flow Log from NAT Gateway
+Delete NAT Gateway Flow Logs
-This will remove a flow log from the NAT gateway.
+Delete the specified NAT Gateway Flow Log.
### Examples
```ruby
require 'time'
@@ -218,19 +218,19 @@
# config.api_key_prefix['Authorization'] = 'Bearer'
end
api_instance = Ionoscloud::NATGatewaysApi.new
datacenter_id = 'datacenter_id_example' # String | The unique ID of the data center.
-nat_gateway_id = 'nat_gateway_id_example' # String | The unique ID of the NAT gateway
-flow_log_id = 'flow_log_id_example' # String | The unique ID of the flow log
+nat_gateway_id = 'nat_gateway_id_example' # String | The unique ID of the NAT Gateway.
+flow_log_id = 'flow_log_id_example' # String | The unique ID of the Flow Log.
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
}
begin
- # Remove Flow Log from NAT Gateway
+ # Delete NAT Gateway Flow Logs
api_instance.datacenters_natgateways_flowlogs_delete(datacenter_id, nat_gateway_id, flow_log_id, opts)
rescue Ionoscloud::ApiError => e
puts "Error when calling NATGatewaysApi->datacenters_natgateways_flowlogs_delete: #{e}"
end
```
@@ -241,11 +241,11 @@
> <Array(nil, Integer, Hash)> datacenters_natgateways_flowlogs_delete_with_http_info(datacenter_id, nat_gateway_id, flow_log_id, opts)
```ruby
begin
- # Remove Flow Log from NAT Gateway
+ # Delete NAT Gateway Flow Logs
data, status_code, headers = api_instance.datacenters_natgateways_flowlogs_delete_with_http_info(datacenter_id, nat_gateway_id, flow_log_id, opts)
p status_code # => 2xx
p headers # => { ... }
p data # => nil
rescue Ionoscloud::ApiError => e
@@ -256,12 +256,12 @@
### Parameters
| Name | Type | Description | Notes |
| ---- | ---- | ----------- | ----- |
| **datacenter_id** | **String** | The unique ID of the data center. | |
-| **nat_gateway_id** | **String** | The unique ID of the NAT gateway | |
-| **flow_log_id** | **String** | The unique ID of the flow log | |
+| **nat_gateway_id** | **String** | The unique ID of the NAT Gateway. | |
+| **flow_log_id** | **String** | The unique ID of the Flow Log. | |
| **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] |
### Return type
@@ -279,13 +279,13 @@
## datacenters_natgateways_flowlogs_find_by_flow_log_id
> <FlowLog> datacenters_natgateways_flowlogs_find_by_flow_log_id(datacenter_id, nat_gateway_id, flow_log_id, opts)
-Retrieve a Flow Log of the NAT Gateway
+Retrieve NAT Gateway Flow Logs
-This will return a Flow Log of the NAT Gateway.
+Retrieve the specified NAT Gateway Flow Log.
### Examples
```ruby
require 'time'
@@ -302,19 +302,19 @@
# config.api_key_prefix['Authorization'] = 'Bearer'
end
api_instance = Ionoscloud::NATGatewaysApi.new
datacenter_id = 'datacenter_id_example' # String | The unique ID of the data center.
-nat_gateway_id = 'nat_gateway_id_example' # String | The unique ID of the NAT gateway
-flow_log_id = 'flow_log_id_example' # String | The unique ID of the flow log
+nat_gateway_id = 'nat_gateway_id_example' # String | The unique ID of the NAT Gateway.
+flow_log_id = 'flow_log_id_example' # String | The unique ID of the Flow Log.
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
}
begin
- # Retrieve a Flow Log of the NAT Gateway
+ # Retrieve NAT Gateway Flow Logs
result = api_instance.datacenters_natgateways_flowlogs_find_by_flow_log_id(datacenter_id, nat_gateway_id, flow_log_id, opts)
p result
rescue Ionoscloud::ApiError => e
puts "Error when calling NATGatewaysApi->datacenters_natgateways_flowlogs_find_by_flow_log_id: #{e}"
end
@@ -326,11 +326,11 @@
> <Array(<FlowLog>, Integer, Hash)> datacenters_natgateways_flowlogs_find_by_flow_log_id_with_http_info(datacenter_id, nat_gateway_id, flow_log_id, opts)
```ruby
begin
- # Retrieve a Flow Log of the NAT Gateway
+ # Retrieve NAT Gateway Flow Logs
data, status_code, headers = api_instance.datacenters_natgateways_flowlogs_find_by_flow_log_id_with_http_info(datacenter_id, nat_gateway_id, flow_log_id, opts)
p status_code # => 2xx
p headers # => { ... }
p data # => <FlowLog>
rescue Ionoscloud::ApiError => e
@@ -341,18 +341,18 @@
### Parameters
| Name | Type | Description | Notes |
| ---- | ---- | ----------- | ----- |
| **datacenter_id** | **String** | The unique ID of the data center. | |
-| **nat_gateway_id** | **String** | The unique ID of the NAT gateway | |
-| **flow_log_id** | **String** | The unique ID of the flow log | |
+| **nat_gateway_id** | **String** | The unique ID of the NAT Gateway. | |
+| **flow_log_id** | **String** | The unique ID of the Flow Log. | |
| **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] |
### Return type
-[**FlowLog**](FlowLog.md)
+[**FlowLog**](../models/FlowLog.md)
### Authorization
Basic Authentication, Token Authentication
@@ -366,11 +366,11 @@
> <FlowLogs> datacenters_natgateways_flowlogs_get(datacenter_id, nat_gateway_id, opts)
List NAT Gateway Flow Logs
-You can retrieve a list of Flow Logs of the NAT Gateway.
+List all the Flow Logs for the specified NAT Gateway.
### Examples
```ruby
require 'time'
@@ -387,11 +387,11 @@
# config.api_key_prefix['Authorization'] = 'Bearer'
end
api_instance = Ionoscloud::NATGatewaysApi.new
datacenter_id = 'datacenter_id_example' # String | The unique ID of the data center.
-nat_gateway_id = 'nat_gateway_id_example' # String | The unique ID of the NAT gateway
+nat_gateway_id = 'nat_gateway_id_example' # String | The unique ID of the NAT Gateway.
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
offset: 56, # Integer | The first element (from the complete list of the elements) to include in the response (use together with limit for pagination).
limit: 56 # Integer | The maximum number of elements to return (use together with offset for pagination).
@@ -427,19 +427,19 @@
### Parameters
| Name | Type | Description | Notes |
| ---- | ---- | ----------- | ----- |
| **datacenter_id** | **String** | The unique ID of the data center. | |
-| **nat_gateway_id** | **String** | The unique ID of the NAT gateway | |
+| **nat_gateway_id** | **String** | The unique ID of the NAT Gateway. | |
| **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] |
| **offset** | **Integer** | The first element (from the complete list of the elements) to include in the response (use together with limit for pagination). | [optional][default to 0] |
| **limit** | **Integer** | The maximum number of elements to return (use together with offset for pagination). | [optional][default to 1000] |
### Return type
-[**FlowLogs**](FlowLogs.md)
+[**FlowLogs**](../models/FlowLogs.md)
### Authorization
Basic Authentication, Token Authentication
@@ -451,13 +451,13 @@
## datacenters_natgateways_flowlogs_patch
> <FlowLog> datacenters_natgateways_flowlogs_patch(datacenter_id, nat_gateway_id, flow_log_id, nat_gateway_flow_log_properties, opts)
-Partially modify a Flow Log of the NAT Gateway
+Partially modify NAT Gateway Flow Logs
-You can use to partially update a Flow Log of a NAT Gateway.
+Update the properties of the specified NAT Gateway Flow Log.
### Examples
```ruby
require 'time'
@@ -474,20 +474,20 @@
# config.api_key_prefix['Authorization'] = 'Bearer'
end
api_instance = Ionoscloud::NATGatewaysApi.new
datacenter_id = 'datacenter_id_example' # String | The unique ID of the data center.
-nat_gateway_id = 'nat_gateway_id_example' # String | The unique ID of the NAT gateway
-flow_log_id = 'flow_log_id_example' # String | The unique ID of the flow log
-nat_gateway_flow_log_properties = Ionoscloud::FlowLogProperties.new({name: 'My resource', action: 'ACCEPTED', direction: 'INGRESS', bucket: 'bucketName/key'}) # FlowLogProperties | Properties of a Flow Log to be updated
+nat_gateway_id = 'nat_gateway_id_example' # String | The unique ID of the NAT Gateway.
+flow_log_id = 'flow_log_id_example' # String | The unique ID of the Flow Log.
+nat_gateway_flow_log_properties = Ionoscloud::FlowLogProperties.new({name: 'My resource', action: 'ACCEPTED', direction: 'INGRESS', bucket: 'bucketName/key'}) # FlowLogProperties | The properties of the Flow Log 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
}
begin
- # Partially modify a Flow Log of the NAT Gateway
+ # Partially modify NAT Gateway Flow Logs
result = api_instance.datacenters_natgateways_flowlogs_patch(datacenter_id, nat_gateway_id, flow_log_id, nat_gateway_flow_log_properties, opts)
p result
rescue Ionoscloud::ApiError => e
puts "Error when calling NATGatewaysApi->datacenters_natgateways_flowlogs_patch: #{e}"
end
@@ -499,11 +499,11 @@
> <Array(<FlowLog>, Integer, Hash)> datacenters_natgateways_flowlogs_patch_with_http_info(datacenter_id, nat_gateway_id, flow_log_id, nat_gateway_flow_log_properties, opts)
```ruby
begin
- # Partially modify a Flow Log of the NAT Gateway
+ # Partially modify NAT Gateway Flow Logs
data, status_code, headers = api_instance.datacenters_natgateways_flowlogs_patch_with_http_info(datacenter_id, nat_gateway_id, flow_log_id, nat_gateway_flow_log_properties, opts)
p status_code # => 2xx
p headers # => { ... }
p data # => <FlowLog>
rescue Ionoscloud::ApiError => e
@@ -514,19 +514,19 @@
### Parameters
| Name | Type | Description | Notes |
| ---- | ---- | ----------- | ----- |
| **datacenter_id** | **String** | The unique ID of the data center. | |
-| **nat_gateway_id** | **String** | The unique ID of the NAT gateway | |
-| **flow_log_id** | **String** | The unique ID of the flow log | |
-| **nat_gateway_flow_log_properties** | [**FlowLogProperties**](FlowLogProperties.md) | Properties of a Flow Log to be updated | |
+| **nat_gateway_id** | **String** | The unique ID of the NAT Gateway. | |
+| **flow_log_id** | **String** | The unique ID of the Flow Log. | |
+| **nat_gateway_flow_log_properties** | [**FlowLogProperties**](FlowLogProperties.md) | The properties of the Flow Log 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] |
### Return type
-[**FlowLog**](FlowLog.md)
+[**FlowLog**](../models/FlowLog.md)
### Authorization
Basic Authentication, Token Authentication
@@ -538,13 +538,13 @@
## datacenters_natgateways_flowlogs_post
> <FlowLog> datacenters_natgateways_flowlogs_post(datacenter_id, nat_gateway_id, nat_gateway_flow_log, opts)
-Add a NAT Gateways Flow Log
+Create NAT Gateway Flow Logs
-This will add a new Flow Log to the NAT Gateway.
+Add a new Flow Log for the specified NAT Gateway.
### Examples
```ruby
require 'time'
@@ -561,19 +561,19 @@
# config.api_key_prefix['Authorization'] = 'Bearer'
end
api_instance = Ionoscloud::NATGatewaysApi.new
datacenter_id = 'datacenter_id_example' # String | The unique ID of the data center.
-nat_gateway_id = 'nat_gateway_id_example' # String | The unique ID of the NAT gateway
-nat_gateway_flow_log = Ionoscloud::FlowLog.new({properties: Ionoscloud::FlowLogProperties.new({name: 'My resource', action: 'ACCEPTED', direction: 'INGRESS', bucket: 'bucketName/key'})}) # FlowLog | Flow Log to add on NAT Gateway
+nat_gateway_id = 'nat_gateway_id_example' # String | The unique ID of the NAT Gateway.
+nat_gateway_flow_log = Ionoscloud::FlowLog.new({properties: Ionoscloud::FlowLogProperties.new({name: 'My resource', action: 'ACCEPTED', direction: 'INGRESS', bucket: 'bucketName/key'})}) # FlowLog | The Flow Log 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
}
begin
- # Add a NAT Gateways Flow Log
+ # Create NAT Gateway Flow Logs
result = api_instance.datacenters_natgateways_flowlogs_post(datacenter_id, nat_gateway_id, nat_gateway_flow_log, opts)
p result
rescue Ionoscloud::ApiError => e
puts "Error when calling NATGatewaysApi->datacenters_natgateways_flowlogs_post: #{e}"
end
@@ -585,11 +585,11 @@
> <Array(<FlowLog>, Integer, Hash)> datacenters_natgateways_flowlogs_post_with_http_info(datacenter_id, nat_gateway_id, nat_gateway_flow_log, opts)
```ruby
begin
- # Add a NAT Gateways Flow Log
+ # Create NAT Gateway Flow Logs
data, status_code, headers = api_instance.datacenters_natgateways_flowlogs_post_with_http_info(datacenter_id, nat_gateway_id, nat_gateway_flow_log, opts)
p status_code # => 2xx
p headers # => { ... }
p data # => <FlowLog>
rescue Ionoscloud::ApiError => e
@@ -600,18 +600,18 @@
### Parameters
| Name | Type | Description | Notes |
| ---- | ---- | ----------- | ----- |
| **datacenter_id** | **String** | The unique ID of the data center. | |
-| **nat_gateway_id** | **String** | The unique ID of the NAT gateway | |
-| **nat_gateway_flow_log** | [**FlowLog**](FlowLog.md) | Flow Log to add on NAT Gateway | |
+| **nat_gateway_id** | **String** | The unique ID of the NAT Gateway. | |
+| **nat_gateway_flow_log** | [**FlowLog**](FlowLog.md) | The Flow Log 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] |
### Return type
-[**FlowLog**](FlowLog.md)
+[**FlowLog**](../models/FlowLog.md)
### Authorization
Basic Authentication, Token Authentication
@@ -623,13 +623,13 @@
## datacenters_natgateways_flowlogs_put
> <FlowLog> datacenters_natgateways_flowlogs_put(datacenter_id, nat_gateway_id, flow_log_id, nat_gateway_flow_log, opts)
-Modify a Flow Log of the NAT Gateway
+Modify NAT Gateway Flow Logs
-You can use to update a Flow Log of the NAT Gateway.
+Modify the specified NAT Gateway Flow Log.
### Examples
```ruby
require 'time'
@@ -646,20 +646,20 @@
# config.api_key_prefix['Authorization'] = 'Bearer'
end
api_instance = Ionoscloud::NATGatewaysApi.new
datacenter_id = 'datacenter_id_example' # String | The unique ID of the data center.
-nat_gateway_id = 'nat_gateway_id_example' # String | The unique ID of the NAT gateway
-flow_log_id = 'flow_log_id_example' # String | The unique ID of the flow log
-nat_gateway_flow_log = Ionoscloud::FlowLogPut.new({properties: Ionoscloud::FlowLogProperties.new({name: 'My resource', action: 'ACCEPTED', direction: 'INGRESS', bucket: 'bucketName/key'})}) # FlowLogPut | Modified NAT Gateway Flow Log
+nat_gateway_id = 'nat_gateway_id_example' # String | The unique ID of the NAT Gateway.
+flow_log_id = 'flow_log_id_example' # String | The unique ID of the Flow Log.
+nat_gateway_flow_log = Ionoscloud::FlowLogPut.new({properties: Ionoscloud::FlowLogProperties.new({name: 'My resource', action: 'ACCEPTED', direction: 'INGRESS', bucket: 'bucketName/key'})}) # FlowLogPut | The modified NAT Gateway Flow Log.
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
}
begin
- # Modify a Flow Log of the NAT Gateway
+ # Modify NAT Gateway Flow Logs
result = api_instance.datacenters_natgateways_flowlogs_put(datacenter_id, nat_gateway_id, flow_log_id, nat_gateway_flow_log, opts)
p result
rescue Ionoscloud::ApiError => e
puts "Error when calling NATGatewaysApi->datacenters_natgateways_flowlogs_put: #{e}"
end
@@ -671,11 +671,11 @@
> <Array(<FlowLog>, Integer, Hash)> datacenters_natgateways_flowlogs_put_with_http_info(datacenter_id, nat_gateway_id, flow_log_id, nat_gateway_flow_log, opts)
```ruby
begin
- # Modify a Flow Log of the NAT Gateway
+ # Modify NAT Gateway Flow Logs
data, status_code, headers = api_instance.datacenters_natgateways_flowlogs_put_with_http_info(datacenter_id, nat_gateway_id, flow_log_id, nat_gateway_flow_log, opts)
p status_code # => 2xx
p headers # => { ... }
p data # => <FlowLog>
rescue Ionoscloud::ApiError => e
@@ -686,19 +686,19 @@
### Parameters
| Name | Type | Description | Notes |
| ---- | ---- | ----------- | ----- |
| **datacenter_id** | **String** | The unique ID of the data center. | |
-| **nat_gateway_id** | **String** | The unique ID of the NAT gateway | |
-| **flow_log_id** | **String** | The unique ID of the flow log | |
-| **nat_gateway_flow_log** | [**FlowLogPut**](FlowLogPut.md) | Modified NAT Gateway Flow Log | |
+| **nat_gateway_id** | **String** | The unique ID of the NAT Gateway. | |
+| **flow_log_id** | **String** | The unique ID of the Flow Log. | |
+| **nat_gateway_flow_log** | [**FlowLogPut**](FlowLogPut.md) | The modified NAT Gateway Flow Log. | |
| **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] |
### Return type
-[**FlowLog**](FlowLog.md)
+[**FlowLog**](../models/FlowLog.md)
### Authorization
Basic Authentication, Token Authentication
@@ -712,11 +712,11 @@
> <NatGateways> datacenters_natgateways_get(datacenter_id, opts)
List NAT Gateways
-Retrieve a list of NAT Gateways within the datacenter.
+List all NAT Gateways within the data center.
### Examples
```ruby
require 'time'
@@ -777,11 +777,11 @@
| **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, against which all API requests are to be executed. | [optional] |
### Return type
-[**NatGateways**](NatGateways.md)
+[**NatGateways**](../models/NatGateways.md)
### Authorization
Basic Authentication, Token Authentication
@@ -793,13 +793,13 @@
## datacenters_natgateways_patch
> <NatGateway> datacenters_natgateways_patch(datacenter_id, nat_gateway_id, nat_gateway_properties, opts)
-Partially update a NAT gateway
+Partially modify NAT Gateways
-Partially update the attributes of a given NAT gateway
+Update the properties of the specified NAT Gateway within the data center.
### Examples
```ruby
require 'time'
@@ -816,20 +816,20 @@
# config.api_key_prefix['Authorization'] = 'Bearer'
end
api_instance = Ionoscloud::NATGatewaysApi.new
datacenter_id = 'datacenter_id_example' # String | The unique ID of the data center.
-nat_gateway_id = 'nat_gateway_id_example' # String | The unique ID of the NAT gateway
-nat_gateway_properties = Ionoscloud::NatGatewayProperties.new({name: 'My NAT Gateway', public_ips: ['public_ips_example']}) # NatGatewayProperties | NAT gateway properties to be updated
+nat_gateway_id = 'nat_gateway_id_example' # String | The unique ID of the NAT Gateway.
+nat_gateway_properties = Ionoscloud::NatGatewayProperties.new({name: 'My NAT Gateway', public_ips: ['public_ips_example']}) # NatGatewayProperties | The properties of the NAT Gateway to be updated.
opts = {
pretty: true, # Boolean | Controls whether the response is pretty-printed (with indentations and new lines).
depth: 56, # Integer | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on
x_contract_number: 56 # Integer | Users with multiple contracts must provide the contract number, against which all API requests are to be executed.
}
begin
- # Partially update a NAT gateway
+ # Partially modify NAT Gateways
result = api_instance.datacenters_natgateways_patch(datacenter_id, nat_gateway_id, nat_gateway_properties, opts)
p result
rescue Ionoscloud::ApiError => e
puts "Error when calling NATGatewaysApi->datacenters_natgateways_patch: #{e}"
end
@@ -841,11 +841,11 @@
> <Array(<NatGateway>, Integer, Hash)> datacenters_natgateways_patch_with_http_info(datacenter_id, nat_gateway_id, nat_gateway_properties, opts)
```ruby
begin
- # Partially update a NAT gateway
+ # Partially modify NAT Gateways
data, status_code, headers = api_instance.datacenters_natgateways_patch_with_http_info(datacenter_id, nat_gateway_id, nat_gateway_properties, opts)
p status_code # => 2xx
p headers # => { ... }
p data # => <NatGateway>
rescue Ionoscloud::ApiError => e
@@ -856,19 +856,19 @@
### Parameters
| Name | Type | Description | Notes |
| ---- | ---- | ----------- | ----- |
| **datacenter_id** | **String** | The unique ID of the data center. | |
-| **nat_gateway_id** | **String** | The unique ID of the NAT gateway | |
-| **nat_gateway_properties** | [**NatGatewayProperties**](NatGatewayProperties.md) | NAT gateway properties to be updated | |
+| **nat_gateway_id** | **String** | The unique ID of the NAT Gateway. | |
+| **nat_gateway_properties** | [**NatGatewayProperties**](NatGatewayProperties.md) | The properties of the NAT Gateway 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, against which all API requests are to be executed. | [optional] |
### Return type
-[**NatGateway**](NatGateway.md)
+[**NatGateway**](../models/NatGateway.md)
### Authorization
Basic Authentication, Token Authentication
@@ -880,13 +880,13 @@
## datacenters_natgateways_post
> <NatGateway> datacenters_natgateways_post(datacenter_id, nat_gateway, opts)
-Create a NAT Gateway
+Create NAT Gateways
-Creates a NAT Gateway within the datacenter. User should be the contract owner or a admin or a user with createInternetAccess privilege
+Create a NAT Gateway within the data center. This operation is restricted to contract owner, admin, and users with 'createInternetAccess' privileges.
### Examples
```ruby
require 'time'
@@ -903,19 +903,19 @@
# config.api_key_prefix['Authorization'] = 'Bearer'
end
api_instance = Ionoscloud::NATGatewaysApi.new
datacenter_id = 'datacenter_id_example' # String | The unique ID of the data center.
-nat_gateway = Ionoscloud::NatGateway.new({properties: Ionoscloud::NatGatewayProperties.new({name: 'My NAT Gateway', public_ips: ['public_ips_example']})}) # NatGateway | NAT gateway to be created
+nat_gateway = Ionoscloud::NatGateway.new({properties: Ionoscloud::NatGatewayProperties.new({name: 'My NAT Gateway', public_ips: ['public_ips_example']})}) # NatGateway | The NAT Gateway to create.
opts = {
pretty: true, # Boolean | Controls whether the response is pretty-printed (with indentations and new lines).
depth: 56, # Integer | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on
x_contract_number: 56 # Integer | Users with multiple contracts must provide the contract number, against which all API requests are to be executed.
}
begin
- # Create a NAT Gateway
+ # Create NAT Gateways
result = api_instance.datacenters_natgateways_post(datacenter_id, nat_gateway, opts)
p result
rescue Ionoscloud::ApiError => e
puts "Error when calling NATGatewaysApi->datacenters_natgateways_post: #{e}"
end
@@ -927,11 +927,11 @@
> <Array(<NatGateway>, Integer, Hash)> datacenters_natgateways_post_with_http_info(datacenter_id, nat_gateway, opts)
```ruby
begin
- # Create a NAT Gateway
+ # Create NAT Gateways
data, status_code, headers = api_instance.datacenters_natgateways_post_with_http_info(datacenter_id, nat_gateway, opts)
p status_code # => 2xx
p headers # => { ... }
p data # => <NatGateway>
rescue Ionoscloud::ApiError => e
@@ -942,18 +942,18 @@
### Parameters
| Name | Type | Description | Notes |
| ---- | ---- | ----------- | ----- |
| **datacenter_id** | **String** | The unique ID of the data center. | |
-| **nat_gateway** | [**NatGateway**](NatGateway.md) | NAT gateway to be created | |
+| **nat_gateway** | [**NatGateway**](NatGateway.md) | The NAT Gateway 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, against which all API requests are to be executed. | [optional] |
### Return type
-[**NatGateway**](NatGateway.md)
+[**NatGateway**](../models/NatGateway.md)
### Authorization
Basic Authentication, Token Authentication
@@ -965,13 +965,13 @@
## datacenters_natgateways_put
> <NatGateway> datacenters_natgateways_put(datacenter_id, nat_gateway_id, nat_gateway, opts)
-Update a NAT gateway
+Modify NAT Gateways
-Update the attributes of a given NAT gateway
+Modify the properties of the specified NAT Gateway within the data center.
### Examples
```ruby
require 'time'
@@ -988,20 +988,20 @@
# config.api_key_prefix['Authorization'] = 'Bearer'
end
api_instance = Ionoscloud::NATGatewaysApi.new
datacenter_id = 'datacenter_id_example' # String | The unique ID of the data center.
-nat_gateway_id = 'nat_gateway_id_example' # String | The unique ID of the NAT gateway
-nat_gateway = Ionoscloud::NatGatewayPut.new({properties: Ionoscloud::NatGatewayProperties.new({name: 'My NAT Gateway', public_ips: ['public_ips_example']})}) # NatGatewayPut | Modified NAT Gateway
+nat_gateway_id = 'nat_gateway_id_example' # String | The unique ID of the NAT Gateway.
+nat_gateway = Ionoscloud::NatGatewayPut.new({properties: Ionoscloud::NatGatewayProperties.new({name: 'My NAT Gateway', public_ips: ['public_ips_example']})}) # NatGatewayPut | The modified NAT Gateway.
opts = {
pretty: true, # Boolean | Controls whether the response is pretty-printed (with indentations and new lines).
depth: 56, # Integer | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on
x_contract_number: 56 # Integer | Users with multiple contracts must provide the contract number, against which all API requests are to be executed.
}
begin
- # Update a NAT gateway
+ # Modify NAT Gateways
result = api_instance.datacenters_natgateways_put(datacenter_id, nat_gateway_id, nat_gateway, opts)
p result
rescue Ionoscloud::ApiError => e
puts "Error when calling NATGatewaysApi->datacenters_natgateways_put: #{e}"
end
@@ -1013,11 +1013,11 @@
> <Array(<NatGateway>, Integer, Hash)> datacenters_natgateways_put_with_http_info(datacenter_id, nat_gateway_id, nat_gateway, opts)
```ruby
begin
- # Update a NAT gateway
+ # Modify NAT Gateways
data, status_code, headers = api_instance.datacenters_natgateways_put_with_http_info(datacenter_id, nat_gateway_id, nat_gateway, opts)
p status_code # => 2xx
p headers # => { ... }
p data # => <NatGateway>
rescue Ionoscloud::ApiError => e
@@ -1028,19 +1028,19 @@
### Parameters
| Name | Type | Description | Notes |
| ---- | ---- | ----------- | ----- |
| **datacenter_id** | **String** | The unique ID of the data center. | |
-| **nat_gateway_id** | **String** | The unique ID of the NAT gateway | |
-| **nat_gateway** | [**NatGatewayPut**](NatGatewayPut.md) | Modified NAT Gateway | |
+| **nat_gateway_id** | **String** | The unique ID of the NAT Gateway. | |
+| **nat_gateway** | [**NatGatewayPut**](NatGatewayPut.md) | The modified NAT Gateway. | |
| **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, against which all API requests are to be executed. | [optional] |
### Return type
-[**NatGateway**](NatGateway.md)
+[**NatGateway**](../models/NatGateway.md)
### Authorization
Basic Authentication, Token Authentication
@@ -1052,13 +1052,13 @@
## datacenters_natgateways_rules_delete
> datacenters_natgateways_rules_delete(datacenter_id, nat_gateway_id, nat_gateway_rule_id, opts)
-Remove rule from NAT Gateway
+Delete NAT Gateway rules
-This will remove a rule from the NAT gateway.
+Delete the specified NAT Gateway rule.
### Examples
```ruby
require 'time'
@@ -1075,20 +1075,20 @@
# config.api_key_prefix['Authorization'] = 'Bearer'
end
api_instance = Ionoscloud::NATGatewaysApi.new
datacenter_id = 'datacenter_id_example' # String | The unique ID of the data center.
-nat_gateway_id = 'nat_gateway_id_example' # String | The unique ID of the NAT gateway
-nat_gateway_rule_id = 'nat_gateway_rule_id_example' # String | The unique ID of the NAT gateway rule
+nat_gateway_id = 'nat_gateway_id_example' # String | The unique ID of the NAT Gateway.
+nat_gateway_rule_id = 'nat_gateway_rule_id_example' # String | The unique ID of the NAT Gateway rule.
opts = {
pretty: true, # Boolean | Controls whether the response is pretty-printed (with indentations and new lines).
depth: 56, # Integer | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on
x_contract_number: 56 # Integer | Users with multiple contracts must provide the contract number, against which all API requests are to be executed.
}
begin
- # Remove rule from NAT Gateway
+ # Delete NAT Gateway rules
api_instance.datacenters_natgateways_rules_delete(datacenter_id, nat_gateway_id, nat_gateway_rule_id, opts)
rescue Ionoscloud::ApiError => e
puts "Error when calling NATGatewaysApi->datacenters_natgateways_rules_delete: #{e}"
end
```
@@ -1099,11 +1099,11 @@
> <Array(nil, Integer, Hash)> datacenters_natgateways_rules_delete_with_http_info(datacenter_id, nat_gateway_id, nat_gateway_rule_id, opts)
```ruby
begin
- # Remove rule from NAT Gateway
+ # Delete NAT Gateway rules
data, status_code, headers = api_instance.datacenters_natgateways_rules_delete_with_http_info(datacenter_id, nat_gateway_id, nat_gateway_rule_id, opts)
p status_code # => 2xx
p headers # => { ... }
p data # => nil
rescue Ionoscloud::ApiError => e
@@ -1114,12 +1114,12 @@
### Parameters
| Name | Type | Description | Notes |
| ---- | ---- | ----------- | ----- |
| **datacenter_id** | **String** | The unique ID of the data center. | |
-| **nat_gateway_id** | **String** | The unique ID of the NAT gateway | |
-| **nat_gateway_rule_id** | **String** | The unique ID of the NAT gateway rule | |
+| **nat_gateway_id** | **String** | The unique ID of the NAT Gateway. | |
+| **nat_gateway_rule_id** | **String** | The unique ID of the NAT Gateway rule. | |
| **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, against which all API requests are to be executed. | [optional] |
### Return type
@@ -1138,13 +1138,13 @@
## datacenters_natgateways_rules_find_by_nat_gateway_rule_id
> <NatGatewayRule> datacenters_natgateways_rules_find_by_nat_gateway_rule_id(datacenter_id, nat_gateway_id, nat_gateway_rule_id, opts)
-Retrieve a NAT Gateway Rule
+Retrieve NAT Gateway rules
-Retrieves the attributes of a given NAT gateway rule.
+Retrieve the properties of the specified NAT Gateway rule.
### Examples
```ruby
require 'time'
@@ -1161,20 +1161,20 @@
# config.api_key_prefix['Authorization'] = 'Bearer'
end
api_instance = Ionoscloud::NATGatewaysApi.new
datacenter_id = 'datacenter_id_example' # String | The unique ID of the data center.
-nat_gateway_id = 'nat_gateway_id_example' # String | The unique ID of the NAT gateway
-nat_gateway_rule_id = 'nat_gateway_rule_id_example' # String | The unique ID of the NAT gateway rule
+nat_gateway_id = 'nat_gateway_id_example' # String | The unique ID of the NAT Gateway.
+nat_gateway_rule_id = 'nat_gateway_rule_id_example' # String | The unique ID of the NAT Gateway rule.
opts = {
pretty: true, # Boolean | Controls whether the response is pretty-printed (with indentations and new lines).
depth: 56, # Integer | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on
x_contract_number: 56 # Integer | Users with multiple contracts must provide the contract number, against which all API requests are to be executed.
}
begin
- # Retrieve a NAT Gateway Rule
+ # Retrieve NAT Gateway rules
result = api_instance.datacenters_natgateways_rules_find_by_nat_gateway_rule_id(datacenter_id, nat_gateway_id, nat_gateway_rule_id, opts)
p result
rescue Ionoscloud::ApiError => e
puts "Error when calling NATGatewaysApi->datacenters_natgateways_rules_find_by_nat_gateway_rule_id: #{e}"
end
@@ -1186,11 +1186,11 @@
> <Array(<NatGatewayRule>, Integer, Hash)> datacenters_natgateways_rules_find_by_nat_gateway_rule_id_with_http_info(datacenter_id, nat_gateway_id, nat_gateway_rule_id, opts)
```ruby
begin
- # Retrieve a NAT Gateway Rule
+ # Retrieve NAT Gateway rules
data, status_code, headers = api_instance.datacenters_natgateways_rules_find_by_nat_gateway_rule_id_with_http_info(datacenter_id, nat_gateway_id, nat_gateway_rule_id, opts)
p status_code # => 2xx
p headers # => { ... }
p data # => <NatGatewayRule>
rescue Ionoscloud::ApiError => e
@@ -1201,19 +1201,19 @@
### Parameters
| Name | Type | Description | Notes |
| ---- | ---- | ----------- | ----- |
| **datacenter_id** | **String** | The unique ID of the data center. | |
-| **nat_gateway_id** | **String** | The unique ID of the NAT gateway | |
-| **nat_gateway_rule_id** | **String** | The unique ID of the NAT gateway rule | |
+| **nat_gateway_id** | **String** | The unique ID of the NAT Gateway. | |
+| **nat_gateway_rule_id** | **String** | The unique ID of the NAT Gateway rule. | |
| **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, against which all API requests are to be executed. | [optional] |
### Return type
-[**NatGatewayRule**](NatGatewayRule.md)
+[**NatGatewayRule**](../models/NatGatewayRule.md)
### Authorization
Basic Authentication, Token Authentication
@@ -1225,13 +1225,13 @@
## datacenters_natgateways_rules_get
> <NatGatewayRules> datacenters_natgateways_rules_get(datacenter_id, nat_gateway_id, opts)
-List NAT Gateways Rules
+List NAT Gateway rules
-Retrieve a list of rules of a NAT Gateway within the datacenter.
+List all rules for the specified NAT Gateway.
### Examples
```ruby
require 'time'
@@ -1248,19 +1248,19 @@
# config.api_key_prefix['Authorization'] = 'Bearer'
end
api_instance = Ionoscloud::NATGatewaysApi.new
datacenter_id = 'datacenter_id_example' # String | The unique ID of the data center.
-nat_gateway_id = 'nat_gateway_id_example' # String | The unique ID of the NAT gateway
+nat_gateway_id = 'nat_gateway_id_example' # String | The unique ID of the NAT Gateway.
opts = {
pretty: true, # Boolean | Controls whether the response is pretty-printed (with indentations and new lines).
depth: 56, # Integer | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on
x_contract_number: 56 # Integer | Users with multiple contracts must provide the contract number, against which all API requests are to be executed.
}
begin
- # List NAT Gateways Rules
+ # List NAT Gateway rules
result = api_instance.datacenters_natgateways_rules_get(datacenter_id, nat_gateway_id, opts)
p result
rescue Ionoscloud::ApiError => e
puts "Error when calling NATGatewaysApi->datacenters_natgateways_rules_get: #{e}"
end
@@ -1272,11 +1272,11 @@
> <Array(<NatGatewayRules>, Integer, Hash)> datacenters_natgateways_rules_get_with_http_info(datacenter_id, nat_gateway_id, opts)
```ruby
begin
- # List NAT Gateways Rules
+ # List NAT Gateway rules
data, status_code, headers = api_instance.datacenters_natgateways_rules_get_with_http_info(datacenter_id, nat_gateway_id, opts)
p status_code # => 2xx
p headers # => { ... }
p data # => <NatGatewayRules>
rescue Ionoscloud::ApiError => e
@@ -1287,18 +1287,18 @@
### Parameters
| Name | Type | Description | Notes |
| ---- | ---- | ----------- | ----- |
| **datacenter_id** | **String** | The unique ID of the data center. | |
-| **nat_gateway_id** | **String** | The unique ID of the NAT gateway | |
+| **nat_gateway_id** | **String** | The unique ID of the NAT Gateway. | |
| **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, against which all API requests are to be executed. | [optional] |
### Return type
-[**NatGatewayRules**](NatGatewayRules.md)
+[**NatGatewayRules**](../models/NatGatewayRules.md)
### Authorization
Basic Authentication, Token Authentication
@@ -1310,13 +1310,13 @@
## datacenters_natgateways_rules_patch
> <NatGatewayRule> datacenters_natgateways_rules_patch(datacenter_id, nat_gateway_id, nat_gateway_rule_id, nat_gateway_rule_properties, opts)
-Partially modify a rule of the NAT gateway
+Partially modify NAT Gateway rules
-You can use to partially update a rule of a NAT gateway.
+Update the properties of the specified NAT Gateway rule.
### Examples
```ruby
require 'time'
@@ -1333,21 +1333,21 @@
# config.api_key_prefix['Authorization'] = 'Bearer'
end
api_instance = Ionoscloud::NATGatewaysApi.new
datacenter_id = 'datacenter_id_example' # String | The unique ID of the data center.
-nat_gateway_id = 'nat_gateway_id_example' # String | The unique ID of the NAT gateway
-nat_gateway_rule_id = 'nat_gateway_rule_id_example' # String | The unique ID of the NAT gateway rule
-nat_gateway_rule_properties = Ionoscloud::NatGatewayRuleProperties.new({name: 'My NAT Gateway Rule', source_subnet: '10.0.1.0/24', public_ip: '192.18.7.17'}) # NatGatewayRuleProperties | Properties of a NAT gateway rule to be updated
+nat_gateway_id = 'nat_gateway_id_example' # String | The unique ID of the NAT Gateway.
+nat_gateway_rule_id = 'nat_gateway_rule_id_example' # String | The unique ID of the NAT Gateway rule.
+nat_gateway_rule_properties = Ionoscloud::NatGatewayRuleProperties.new({name: 'My NAT Gateway rule', source_subnet: '10.0.1.0/24', public_ip: '192.18.7.17'}) # NatGatewayRuleProperties | The properties of the NAT Gateway rule to be updated.
opts = {
pretty: true, # Boolean | Controls whether the response is pretty-printed (with indentations and new lines).
depth: 56, # Integer | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on
x_contract_number: 56 # Integer | Users with multiple contracts must provide the contract number, against which all API requests are to be executed.
}
begin
- # Partially modify a rule of the NAT gateway
+ # Partially modify NAT Gateway rules
result = api_instance.datacenters_natgateways_rules_patch(datacenter_id, nat_gateway_id, nat_gateway_rule_id, nat_gateway_rule_properties, opts)
p result
rescue Ionoscloud::ApiError => e
puts "Error when calling NATGatewaysApi->datacenters_natgateways_rules_patch: #{e}"
end
@@ -1359,11 +1359,11 @@
> <Array(<NatGatewayRule>, Integer, Hash)> datacenters_natgateways_rules_patch_with_http_info(datacenter_id, nat_gateway_id, nat_gateway_rule_id, nat_gateway_rule_properties, opts)
```ruby
begin
- # Partially modify a rule of the NAT gateway
+ # Partially modify NAT Gateway rules
data, status_code, headers = api_instance.datacenters_natgateways_rules_patch_with_http_info(datacenter_id, nat_gateway_id, nat_gateway_rule_id, nat_gateway_rule_properties, opts)
p status_code # => 2xx
p headers # => { ... }
p data # => <NatGatewayRule>
rescue Ionoscloud::ApiError => e
@@ -1374,20 +1374,20 @@
### Parameters
| Name | Type | Description | Notes |
| ---- | ---- | ----------- | ----- |
| **datacenter_id** | **String** | The unique ID of the data center. | |
-| **nat_gateway_id** | **String** | The unique ID of the NAT gateway | |
-| **nat_gateway_rule_id** | **String** | The unique ID of the NAT gateway rule | |
-| **nat_gateway_rule_properties** | [**NatGatewayRuleProperties**](NatGatewayRuleProperties.md) | Properties of a NAT gateway rule to be updated | |
+| **nat_gateway_id** | **String** | The unique ID of the NAT Gateway. | |
+| **nat_gateway_rule_id** | **String** | The unique ID of the NAT Gateway rule. | |
+| **nat_gateway_rule_properties** | [**NatGatewayRuleProperties**](NatGatewayRuleProperties.md) | The properties of the NAT Gateway rule 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, against which all API requests are to be executed. | [optional] |
### Return type
-[**NatGatewayRule**](NatGatewayRule.md)
+[**NatGatewayRule**](../models/NatGatewayRule.md)
### Authorization
Basic Authentication, Token Authentication
@@ -1399,13 +1399,13 @@
## datacenters_natgateways_rules_post
> <NatGatewayRule> datacenters_natgateways_rules_post(datacenter_id, nat_gateway_id, nat_gateway_rule, opts)
-Create a NAT Gateway Rule
+Create NAT Gateway rules
-Creates a rule within the NAT Gateway of a datacenter.
+Create a rule for the specified NAT Gateway.
### Examples
```ruby
require 'time'
@@ -1422,20 +1422,20 @@
# config.api_key_prefix['Authorization'] = 'Bearer'
end
api_instance = Ionoscloud::NATGatewaysApi.new
datacenter_id = 'datacenter_id_example' # String | The unique ID of the data center.
-nat_gateway_id = 'nat_gateway_id_example' # String | The unique ID of the NAT gateway
-nat_gateway_rule = Ionoscloud::NatGatewayRule.new({properties: Ionoscloud::NatGatewayRuleProperties.new({name: 'My NAT Gateway Rule', source_subnet: '10.0.1.0/24', public_ip: '192.18.7.17'})}) # NatGatewayRule | NAT gateway rule to be created
+nat_gateway_id = 'nat_gateway_id_example' # String | The unique ID of the NAT Gateway.
+nat_gateway_rule = Ionoscloud::NatGatewayRule.new({properties: Ionoscloud::NatGatewayRuleProperties.new({name: 'My NAT Gateway rule', source_subnet: '10.0.1.0/24', public_ip: '192.18.7.17'})}) # NatGatewayRule | The NAT Gateway rule to create.
opts = {
pretty: true, # Boolean | Controls whether the response is pretty-printed (with indentations and new lines).
depth: 56, # Integer | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on
x_contract_number: 56 # Integer | Users with multiple contracts must provide the contract number, against which all API requests are to be executed.
}
begin
- # Create a NAT Gateway Rule
+ # Create NAT Gateway rules
result = api_instance.datacenters_natgateways_rules_post(datacenter_id, nat_gateway_id, nat_gateway_rule, opts)
p result
rescue Ionoscloud::ApiError => e
puts "Error when calling NATGatewaysApi->datacenters_natgateways_rules_post: #{e}"
end
@@ -1447,11 +1447,11 @@
> <Array(<NatGatewayRule>, Integer, Hash)> datacenters_natgateways_rules_post_with_http_info(datacenter_id, nat_gateway_id, nat_gateway_rule, opts)
```ruby
begin
- # Create a NAT Gateway Rule
+ # Create NAT Gateway rules
data, status_code, headers = api_instance.datacenters_natgateways_rules_post_with_http_info(datacenter_id, nat_gateway_id, nat_gateway_rule, opts)
p status_code # => 2xx
p headers # => { ... }
p data # => <NatGatewayRule>
rescue Ionoscloud::ApiError => e
@@ -1462,19 +1462,19 @@
### Parameters
| Name | Type | Description | Notes |
| ---- | ---- | ----------- | ----- |
| **datacenter_id** | **String** | The unique ID of the data center. | |
-| **nat_gateway_id** | **String** | The unique ID of the NAT gateway | |
-| **nat_gateway_rule** | [**NatGatewayRule**](NatGatewayRule.md) | NAT gateway rule to be created | |
+| **nat_gateway_id** | **String** | The unique ID of the NAT Gateway. | |
+| **nat_gateway_rule** | [**NatGatewayRule**](NatGatewayRule.md) | The NAT Gateway rule 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, against which all API requests are to be executed. | [optional] |
### Return type
-[**NatGatewayRule**](NatGatewayRule.md)
+[**NatGatewayRule**](../models/NatGatewayRule.md)
### Authorization
Basic Authentication, Token Authentication
@@ -1486,13 +1486,13 @@
## datacenters_natgateways_rules_put
> <NatGatewayRule> datacenters_natgateways_rules_put(datacenter_id, nat_gateway_id, nat_gateway_rule_id, nat_gateway_rule, opts)
-Modify a rule of the NAT gateway
+Modify NAT Gateway rules
-You can use to update a rule of the NAT gateway.
+Modify the specified NAT Gateway rule.
### Examples
```ruby
require 'time'
@@ -1509,21 +1509,21 @@
# config.api_key_prefix['Authorization'] = 'Bearer'
end
api_instance = Ionoscloud::NATGatewaysApi.new
datacenter_id = 'datacenter_id_example' # String | The unique ID of the data center.
-nat_gateway_id = 'nat_gateway_id_example' # String | The unique ID of the NAT gateway
-nat_gateway_rule_id = 'nat_gateway_rule_id_example' # String | The unique ID of the NAT gateway rule
-nat_gateway_rule = Ionoscloud::NatGatewayRulePut.new({properties: Ionoscloud::NatGatewayRuleProperties.new({name: 'My NAT Gateway Rule', source_subnet: '10.0.1.0/24', public_ip: '192.18.7.17'})}) # NatGatewayRulePut | Modified NAT Gateway Rule
+nat_gateway_id = 'nat_gateway_id_example' # String | The unique ID of the NAT Gateway.
+nat_gateway_rule_id = 'nat_gateway_rule_id_example' # String | The unique ID of the NAT Gateway rule.
+nat_gateway_rule = Ionoscloud::NatGatewayRulePut.new({properties: Ionoscloud::NatGatewayRuleProperties.new({name: 'My NAT Gateway rule', source_subnet: '10.0.1.0/24', public_ip: '192.18.7.17'})}) # NatGatewayRulePut | The modified NAT Gateway rule.
opts = {
pretty: true, # Boolean | Controls whether the response is pretty-printed (with indentations and new lines).
depth: 56, # Integer | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on
x_contract_number: 56 # Integer | Users with multiple contracts must provide the contract number, against which all API requests are to be executed.
}
begin
- # Modify a rule of the NAT gateway
+ # Modify NAT Gateway rules
result = api_instance.datacenters_natgateways_rules_put(datacenter_id, nat_gateway_id, nat_gateway_rule_id, nat_gateway_rule, opts)
p result
rescue Ionoscloud::ApiError => e
puts "Error when calling NATGatewaysApi->datacenters_natgateways_rules_put: #{e}"
end
@@ -1535,11 +1535,11 @@
> <Array(<NatGatewayRule>, Integer, Hash)> datacenters_natgateways_rules_put_with_http_info(datacenter_id, nat_gateway_id, nat_gateway_rule_id, nat_gateway_rule, opts)
```ruby
begin
- # Modify a rule of the NAT gateway
+ # Modify NAT Gateway rules
data, status_code, headers = api_instance.datacenters_natgateways_rules_put_with_http_info(datacenter_id, nat_gateway_id, nat_gateway_rule_id, nat_gateway_rule, opts)
p status_code # => 2xx
p headers # => { ... }
p data # => <NatGatewayRule>
rescue Ionoscloud::ApiError => e
@@ -1550,19 +1550,19 @@
### Parameters
| Name | Type | Description | Notes |
| ---- | ---- | ----------- | ----- |
| **datacenter_id** | **String** | The unique ID of the data center. | |
-| **nat_gateway_id** | **String** | The unique ID of the NAT gateway | |
-| **nat_gateway_rule_id** | **String** | The unique ID of the NAT gateway rule | |
-| **nat_gateway_rule** | [**NatGatewayRulePut**](NatGatewayRulePut.md) | Modified NAT Gateway Rule | |
+| **nat_gateway_id** | **String** | The unique ID of the NAT Gateway. | |
+| **nat_gateway_rule_id** | **String** | The unique ID of the NAT Gateway rule. | |
+| **nat_gateway_rule** | [**NatGatewayRulePut**](NatGatewayRulePut.md) | The modified NAT Gateway rule. | |
| **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, against which all API requests are to be executed. | [optional] |
### Return type
-[**NatGatewayRule**](NatGatewayRule.md)
+[**NatGatewayRule**](../models/NatGatewayRule.md)
### Authorization
Basic Authentication, Token Authentication