NATGatewaysApi
All URIs are relative to https://api.ionos.com/cloudapi/v6
Method | HTTP request | Description |
---|---|---|
DELETE /datacenters/{datacenterId}/natgateways/{natGatewayId} | Delete NAT Gateways | |
GET /datacenters/{datacenterId}/natgateways/{natGatewayId} | Retrieve NAT Gateways | |
DELETE /datacenters/{datacenterId}/natgateways/{natGatewayId}/flowlogs/{flowLogId} | Delete NAT Gateway Flow Logs | |
GET /datacenters/{datacenterId}/natgateways/{natGatewayId}/flowlogs/{flowLogId} | Retrieve NAT Gateway Flow Logs | |
GET /datacenters/{datacenterId}/natgateways/{natGatewayId}/flowlogs | List NAT Gateway Flow Logs | |
PATCH /datacenters/{datacenterId}/natgateways/{natGatewayId}/flowlogs/{flowLogId} | Partially modify NAT Gateway Flow Logs | |
POST /datacenters/{datacenterId}/natgateways/{natGatewayId}/flowlogs | Create a NAT Gateway Flow Log | |
PUT /datacenters/{datacenterId}/natgateways/{natGatewayId}/flowlogs/{flowLogId} | Modify NAT Gateway Flow Logs | |
GET /datacenters/{datacenterId}/natgateways | List NAT Gateways | |
PATCH /datacenters/{datacenterId}/natgateways/{natGatewayId} | Partially modify NAT Gateways | |
POST /datacenters/{datacenterId}/natgateways | Create a NAT Gateway | |
PUT /datacenters/{datacenterId}/natgateways/{natGatewayId} | Modify NAT Gateways | |
DELETE /datacenters/{datacenterId}/natgateways/{natGatewayId}/rules/{natGatewayRuleId} | Delete NAT Gateway rules | |
GET /datacenters/{datacenterId}/natgateways/{natGatewayId}/rules/{natGatewayRuleId} | Retrieve NAT Gateway rules | |
GET /datacenters/{datacenterId}/natgateways/{natGatewayId}/rules | List NAT Gateway rules | |
PATCH /datacenters/{datacenterId}/natgateways/{natGatewayId}/rules/{natGatewayRuleId} | Partially Modify a NAT Gateway Rule by ID | |
POST /datacenters/{datacenterId}/natgateways/{natGatewayId}/rules | Create a NAT Gateway Rule | |
PUT /datacenters/{datacenterId}/natgateways/{natGatewayId}/rules/{natGatewayRuleId} | Modify a NAT Gateway Rule by ID |
datacenters_natgateways_delete(datacenter_id, nat_gateway_id, pretty=pretty, depth=depth, x_contract_number=x_contract_number)
Delete NAT Gateways
Remove the specified NAT Gateway from the data center.
from __future__ import print_function
import time
import ionoscloud
from ionoscloud.rest import ApiException
# Defining the host is optional and defaults to https://api.ionos.com/cloudapi/v6
configuration = ionoscloud.Configuration(
host = 'https://api.ionos.com/cloudapi/v6',
)
# Example of configuring HTTP Basic Authorization
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'
with ionoscloud.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = ionoscloud.NATGatewaysApi(api_client)
datacenter_id = 'datacenter_id_example' # str | The unique ID of the data center.
nat_gateway_id = 'nat_gateway_id_example' # str | The unique ID of the NAT Gateway.
try:
# Delete NAT Gateways
api_instance.datacenters_natgateways_delete(datacenter_id, nat_gateway_id)
except ApiException as e:
print('Exception when calling NATGatewaysApi.datacenters_natgateways_delete: %s\n' % e)
Name | Type | Description | Notes |
---|---|---|---|
datacenter_id | str | The unique ID of the data center. | |
nat_gateway_id | str | The unique ID of the NAT Gateway. | |
pretty | bool | Controls whether the response is pretty-printed (with indentations and new lines). | [optional] [default to True] |
depth | int | 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 | int | Users with multiple contracts must provide the contract number, for which all API requests are to be executed. | [optional] |
void (empty response body)
Basic Authentication, Token Authentication
- Content-Type: Not defined
- Accept: application/json
NatGateway datacenters_natgateways_find_by_nat_gateway_id(datacenter_id, nat_gateway_id, pretty=pretty, depth=depth, x_contract_number=x_contract_number)
Retrieve NAT Gateways
Retrieve the properties of the specified NAT Gateway within the data center.
from __future__ import print_function
import time
import ionoscloud
from ionoscloud.rest import ApiException
# Defining the host is optional and defaults to https://api.ionos.com/cloudapi/v6
configuration = ionoscloud.Configuration(
host = 'https://api.ionos.com/cloudapi/v6',
)
# Example of configuring HTTP Basic Authorization
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'
with ionoscloud.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = ionoscloud.NATGatewaysApi(api_client)
datacenter_id = 'datacenter_id_example' # str | The unique ID of the data center.
nat_gateway_id = 'nat_gateway_id_example' # str | The unique ID of the NAT Gateway.
try:
# Retrieve NAT Gateways
api_response = api_instance.datacenters_natgateways_find_by_nat_gateway_id(datacenter_id, nat_gateway_id)
print(api_response)
except ApiException as e:
print('Exception when calling NATGatewaysApi.datacenters_natgateways_find_by_nat_gateway_id: %s\n' % e)
Name | Type | Description | Notes |
---|---|---|---|
datacenter_id | str | The unique ID of the data center. | |
nat_gateway_id | str | The unique ID of the NAT Gateway. | |
pretty | bool | Controls whether the response is pretty-printed (with indentations and new lines). | [optional] [default to True] |
depth | int | 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 | int | Users with multiple contracts must provide the contract number, for which all API requests are to be executed. | [optional] |
Basic Authentication, Token Authentication
- Content-Type: Not defined
- Accept: application/json
datacenters_natgateways_flowlogs_delete(datacenter_id, nat_gateway_id, flow_log_id, pretty=pretty, depth=depth)
Delete NAT Gateway Flow Logs
Delete the specified NAT Gateway Flow Log.
from __future__ import print_function
import time
import ionoscloud
from ionoscloud.rest import ApiException
# Defining the host is optional and defaults to https://api.ionos.com/cloudapi/v6
configuration = ionoscloud.Configuration(
host = 'https://api.ionos.com/cloudapi/v6',
)
# Example of configuring HTTP Basic Authorization
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'
with ionoscloud.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = ionoscloud.NATGatewaysApi(api_client)
datacenter_id = 'datacenter_id_example' # str | The unique ID of the data center.
nat_gateway_id = 'nat_gateway_id_example' # str | The unique ID of the NAT Gateway.
flow_log_id = 'flow_log_id_example' # str | The unique ID of the Flow Log.
try:
# Delete NAT Gateway Flow Logs
api_instance.datacenters_natgateways_flowlogs_delete(datacenter_id, nat_gateway_id, flow_log_id)
except ApiException as e:
print('Exception when calling NATGatewaysApi.datacenters_natgateways_flowlogs_delete: %s\n' % e)
Name | Type | Description | Notes |
---|---|---|---|
datacenter_id | str | The unique ID of the data center. | |
nat_gateway_id | str | The unique ID of the NAT Gateway. | |
flow_log_id | str | The unique ID of the Flow Log. | |
pretty | bool | Controls whether the response is pretty-printed (with indentations and new lines). | [optional] [default to True] |
depth | int | 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] |
void (empty response body)
Basic Authentication, Token Authentication
- Content-Type: Not defined
- Accept: application/json
FlowLog datacenters_natgateways_flowlogs_find_by_flow_log_id(datacenter_id, nat_gateway_id, flow_log_id, pretty=pretty, depth=depth)
Retrieve NAT Gateway Flow Logs
Retrieve the specified NAT Gateway Flow Log.
from __future__ import print_function
import time
import ionoscloud
from ionoscloud.rest import ApiException
# Defining the host is optional and defaults to https://api.ionos.com/cloudapi/v6
configuration = ionoscloud.Configuration(
host = 'https://api.ionos.com/cloudapi/v6',
)
# Example of configuring HTTP Basic Authorization
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'
with ionoscloud.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = ionoscloud.NATGatewaysApi(api_client)
datacenter_id = 'datacenter_id_example' # str | The unique ID of the data center.
nat_gateway_id = 'nat_gateway_id_example' # str | The unique ID of the NAT Gateway.
flow_log_id = 'flow_log_id_example' # str | The unique ID of the Flow Log.
try:
# Retrieve NAT Gateway Flow Logs
api_response = api_instance.datacenters_natgateways_flowlogs_find_by_flow_log_id(datacenter_id, nat_gateway_id, flow_log_id)
print(api_response)
except ApiException as e:
print('Exception when calling NATGatewaysApi.datacenters_natgateways_flowlogs_find_by_flow_log_id: %s\n' % e)
Name | Type | Description | Notes |
---|---|---|---|
datacenter_id | str | The unique ID of the data center. | |
nat_gateway_id | str | The unique ID of the NAT Gateway. | |
flow_log_id | str | The unique ID of the Flow Log. | |
pretty | bool | Controls whether the response is pretty-printed (with indentations and new lines). | [optional] [default to True] |
depth | int | 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] |
Basic Authentication, Token Authentication
- Content-Type: Not defined
- Accept: application/json
FlowLogs datacenters_natgateways_flowlogs_get(datacenter_id, nat_gateway_id, pretty=pretty, depth=depth, offset=offset, limit=limit)
List NAT Gateway Flow Logs
List all the Flow Logs for the specified NAT Gateway.
from __future__ import print_function
import time
import ionoscloud
from ionoscloud.rest import ApiException
# Defining the host is optional and defaults to https://api.ionos.com/cloudapi/v6
configuration = ionoscloud.Configuration(
host = 'https://api.ionos.com/cloudapi/v6',
)
# Example of configuring HTTP Basic Authorization
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'
with ionoscloud.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = ionoscloud.NATGatewaysApi(api_client)
datacenter_id = 'datacenter_id_example' # str | The unique ID of the data center.
nat_gateway_id = 'nat_gateway_id_example' # str | The unique ID of the NAT Gateway.
try:
# List NAT Gateway Flow Logs
api_response = api_instance.datacenters_natgateways_flowlogs_get(datacenter_id, nat_gateway_id)
print(api_response)
except ApiException as e:
print('Exception when calling NATGatewaysApi.datacenters_natgateways_flowlogs_get: %s\n' % e)
Name | Type | Description | Notes |
---|---|---|---|
datacenter_id | str | The unique ID of the data center. | |
nat_gateway_id | str | The unique ID of the NAT Gateway. | |
pretty | bool | Controls whether the response is pretty-printed (with indentations and new lines). | [optional] [default to True] |
depth | int | 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 | int | The first element (from the complete list of the elements) to include in the response (used together with <b><i>limit</i></b> for pagination). | [optional] [default to 0] |
limit | int | The maximum number of elements to return (use together with offset for pagination). | [optional] [default to 1000] |
Basic Authentication, Token Authentication
- Content-Type: Not defined
- Accept: application/json
FlowLog datacenters_natgateways_flowlogs_patch(datacenter_id, nat_gateway_id, flow_log_id, nat_gateway_flow_log_properties, pretty=pretty, depth=depth)
Partially modify NAT Gateway Flow Logs
Update the properties of the specified NAT Gateway Flow Log.
from __future__ import print_function
import time
import ionoscloud
from ionoscloud.rest import ApiException
# Defining the host is optional and defaults to https://api.ionos.com/cloudapi/v6
configuration = ionoscloud.Configuration(
host = 'https://api.ionos.com/cloudapi/v6',
)
# Example of configuring HTTP Basic Authorization
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'
with ionoscloud.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = ionoscloud.NATGatewaysApi(api_client)
datacenter_id = 'datacenter_id_example' # str | The unique ID of the data center.
nat_gateway_id = 'nat_gateway_id_example' # str | The unique ID of the NAT Gateway.
flow_log_id = 'flow_log_id_example' # str | The unique ID of the Flow Log.
nat_gateway_flow_log_properties = ionoscloud.FlowLogProperties() # FlowLogProperties | The properties of the Flow Log to be updated.
try:
# Partially modify NAT Gateway Flow Logs
api_response = api_instance.datacenters_natgateways_flowlogs_patch(datacenter_id, nat_gateway_id, flow_log_id, nat_gateway_flow_log_properties)
print(api_response)
except ApiException as e:
print('Exception when calling NATGatewaysApi.datacenters_natgateways_flowlogs_patch: %s\n' % e)
Name | Type | Description | Notes |
---|---|---|---|
datacenter_id | str | The unique ID of the data center. | |
nat_gateway_id | str | The unique ID of the NAT Gateway. | |
flow_log_id | str | The unique ID of the Flow Log. | |
nat_gateway_flow_log_properties | The properties of the Flow Log to be updated. | | |
pretty | bool | Controls whether the response is pretty-printed (with indentations and new lines). | [optional] [default to True] |
depth | int | 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] |
Basic Authentication, Token Authentication
- Content-Type: Not defined
- Accept: application/json
FlowLog datacenters_natgateways_flowlogs_post(datacenter_id, nat_gateway_id, nat_gateway_flow_log, pretty=pretty, depth=depth)
Create a NAT Gateway Flow Log
Adds a new Flow Log to the specified NAT Gateway.
from __future__ import print_function
import time
import ionoscloud
from ionoscloud.rest import ApiException
# Defining the host is optional and defaults to https://api.ionos.com/cloudapi/v6
configuration = ionoscloud.Configuration(
host = 'https://api.ionos.com/cloudapi/v6',
)
# Example of configuring HTTP Basic Authorization
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'
with ionoscloud.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = ionoscloud.NATGatewaysApi(api_client)
datacenter_id = 'datacenter_id_example' # str | The unique ID of the data center.
nat_gateway_id = 'nat_gateway_id_example' # str | The unique ID of the NAT Gateway.
nat_gateway_flow_log = ionoscloud.FlowLog() # FlowLog | The Flow Log to create.
try:
# Create a NAT Gateway Flow Log
api_response = api_instance.datacenters_natgateways_flowlogs_post(datacenter_id, nat_gateway_id, nat_gateway_flow_log)
print(api_response)
except ApiException as e:
print('Exception when calling NATGatewaysApi.datacenters_natgateways_flowlogs_post: %s\n' % e)
Name | Type | Description | Notes |
---|---|---|---|
datacenter_id | str | The unique ID of the data center. | |
nat_gateway_id | str | The unique ID of the NAT Gateway. | |
nat_gateway_flow_log | The Flow Log to create. | | |
pretty | bool | Controls whether the response is pretty-printed (with indentations and new lines). | [optional] [default to True] |
depth | int | 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] |
Basic Authentication, Token Authentication
- Content-Type: application/json
- Accept: application/json
FlowLog datacenters_natgateways_flowlogs_put(datacenter_id, nat_gateway_id, flow_log_id, nat_gateway_flow_log, pretty=pretty, depth=depth)
Modify NAT Gateway Flow Logs
Modify the specified NAT Gateway Flow Log.
from __future__ import print_function
import time
import ionoscloud
from ionoscloud.rest import ApiException
# Defining the host is optional and defaults to https://api.ionos.com/cloudapi/v6
configuration = ionoscloud.Configuration(
host = 'https://api.ionos.com/cloudapi/v6',
)
# Example of configuring HTTP Basic Authorization
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'
with ionoscloud.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = ionoscloud.NATGatewaysApi(api_client)
datacenter_id = 'datacenter_id_example' # str | The unique ID of the data center.
nat_gateway_id = 'nat_gateway_id_example' # str | The unique ID of the NAT Gateway.
flow_log_id = 'flow_log_id_example' # str | The unique ID of the Flow Log.
nat_gateway_flow_log = ionoscloud.FlowLogPut() # FlowLogPut | The modified NAT Gateway Flow Log.
try:
# Modify NAT Gateway Flow Logs
api_response = api_instance.datacenters_natgateways_flowlogs_put(datacenter_id, nat_gateway_id, flow_log_id, nat_gateway_flow_log)
print(api_response)
except ApiException as e:
print('Exception when calling NATGatewaysApi.datacenters_natgateways_flowlogs_put: %s\n' % e)
Name | Type | Description | Notes |
---|---|---|---|
datacenter_id | str | The unique ID of the data center. | |
nat_gateway_id | str | The unique ID of the NAT Gateway. | |
flow_log_id | str | The unique ID of the Flow Log. | |
nat_gateway_flow_log | The modified NAT Gateway Flow Log. | | |
pretty | bool | Controls whether the response is pretty-printed (with indentations and new lines). | [optional] [default to True] |
depth | int | 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] |
Basic Authentication, Token Authentication
- Content-Type: application/json
- Accept: application/json
NatGateways datacenters_natgateways_get(datacenter_id, pretty=pretty, depth=depth, x_contract_number=x_contract_number)
List NAT Gateways
List all NAT Gateways within the data center.
from __future__ import print_function
import time
import ionoscloud
from ionoscloud.rest import ApiException
# Defining the host is optional and defaults to https://api.ionos.com/cloudapi/v6
configuration = ionoscloud.Configuration(
host = 'https://api.ionos.com/cloudapi/v6',
)
# Example of configuring HTTP Basic Authorization
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'
with ionoscloud.ApiClient(configuration) as api_client:
# Create an instance of the API class