NATGatewaysApi
All URIs are relative to https://api.ionos.com/cloudapi/v6
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
Patch /datacenters/{datacenterId}/natgateways/{natGatewayId}
Partially modify NAT Gateways
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
DatacentersNatgatewaysDelete
Delete NAT Gateways
Example
Path Parameters
ctx
context.Context
context for authentication, logging, cancellation, deadlines, tracing, etc.
datacenterId
string
The unique ID of the data center.
natGatewayId
string
The unique ID of the NAT Gateway.
Other Parameters
Other parameters are passed through a pointer to an apiDatacentersNatgatewaysDeleteRequest struct via the builder pattern
pretty
bool
Controls whether the response is pretty-printed (with indentations and new lines).
[default to true]
depth
int32
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
[default to 0]
xContractNumber
int32
Users with multiple contracts must provide the contract number, for which all API requests are to be executed.
Return type
(empty response body)
HTTP request headers
Content-Type: Not defined
Accept: application/json
DatacentersNatgatewaysFindByNatGatewayId
Retrieve NAT Gateways
Example
Path Parameters
ctx
context.Context
context for authentication, logging, cancellation, deadlines, tracing, etc.
datacenterId
string
The unique ID of the data center.
natGatewayId
string
The unique ID of the NAT Gateway.
Other Parameters
Other parameters are passed through a pointer to an apiDatacentersNatgatewaysFindByNatGatewayIdRequest struct via the builder pattern
pretty
bool
Controls whether the response is pretty-printed (with indentations and new lines).
[default to true]
depth
int32
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
[default to 0]
xContractNumber
int32
Users with multiple contracts must provide the contract number, for which all API requests are to be executed.
Return type
HTTP request headers
Content-Type: Not defined
Accept: application/json
DatacentersNatgatewaysFlowlogsDelete
Delete NAT Gateway Flow Logs
Example
Path Parameters
ctx
context.Context
context for authentication, logging, cancellation, deadlines, tracing, etc.
datacenterId
string
The unique ID of the data center.
natGatewayId
string
The unique ID of the NAT Gateway.
flowLogId
string
The unique ID of the Flow Log.
Other Parameters
Other parameters are passed through a pointer to an apiDatacentersNatgatewaysFlowlogsDeleteRequest struct via the builder pattern
pretty
bool
Controls whether the response is pretty-printed (with indentations and new lines).
[default to true]
depth
int32
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
[default to 0]
Return type
(empty response body)
HTTP request headers
Content-Type: Not defined
Accept: application/json
DatacentersNatgatewaysFlowlogsFindByFlowLogId
Retrieve NAT Gateway Flow Logs
Example
Path Parameters
ctx
context.Context
context for authentication, logging, cancellation, deadlines, tracing, etc.
datacenterId
string
The unique ID of the data center.
natGatewayId
string
The unique ID of the NAT Gateway.
flowLogId
string
The unique ID of the Flow Log.
Other Parameters
Other parameters are passed through a pointer to an apiDatacentersNatgatewaysFlowlogsFindByFlowLogIdRequest struct via the builder pattern
pretty
bool
Controls whether the response is pretty-printed (with indentations and new lines).
[default to true]
depth
int32
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
[default to 0]
Return type
HTTP request headers
Content-Type: Not defined
Accept: application/json
DatacentersNatgatewaysFlowlogsGet
List NAT Gateway Flow Logs
Example
Path Parameters
ctx
context.Context
context for authentication, logging, cancellation, deadlines, tracing, etc.
datacenterId
string
The unique ID of the data center.
natGatewayId
string
The unique ID of the NAT Gateway.
Other Parameters
Other parameters are passed through a pointer to an apiDatacentersNatgatewaysFlowlogsGetRequest struct via the builder pattern
pretty
bool
Controls whether the response is pretty-printed (with indentations and new lines).
[default to true]
depth
int32
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
[default to 0]
offset
int32
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).
[default to 0]
limit
int32
The maximum number of elements to return (use together with offset for pagination).
[default to 1000]
Return type
HTTP request headers
Content-Type: Not defined
Accept: application/json
DatacentersNatgatewaysFlowlogsPatch
Partially modify NAT Gateway Flow Logs
Example
Path Parameters
ctx
context.Context
context for authentication, logging, cancellation, deadlines, tracing, etc.
datacenterId
string
The unique ID of the data center.
natGatewayId
string
The unique ID of the NAT Gateway.
flowLogId
string
The unique ID of the Flow Log.
Other Parameters
Other parameters are passed through a pointer to an apiDatacentersNatgatewaysFlowlogsPatchRequest struct via the builder pattern
pretty
bool
Controls whether the response is pretty-printed (with indentations and new lines).
[default to true]
depth
int32
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
[default to 0]
Return type
HTTP request headers
Content-Type: Not defined
Accept: application/json
DatacentersNatgatewaysFlowlogsPost
Create a NAT Gateway Flow Log
Example
Path Parameters
ctx
context.Context
context for authentication, logging, cancellation, deadlines, tracing, etc.
datacenterId
string
The unique ID of the data center.
natGatewayId
string
The unique ID of the NAT Gateway.
Other Parameters
Other parameters are passed through a pointer to an apiDatacentersNatgatewaysFlowlogsPostRequest struct via the builder pattern
pretty
bool
Controls whether the response is pretty-printed (with indentations and new lines).
[default to true]
depth
int32
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
[default to 0]
Return type
HTTP request headers
Content-Type: application/json
Accept: application/json
DatacentersNatgatewaysFlowlogsPut
Modify NAT Gateway Flow Logs
Example
Path Parameters
ctx
context.Context
context for authentication, logging, cancellation, deadlines, tracing, etc.
datacenterId
string
The unique ID of the data center.
natGatewayId
string
The unique ID of the NAT Gateway.
flowLogId
string
The unique ID of the Flow Log.
Other Parameters
Other parameters are passed through a pointer to an apiDatacentersNatgatewaysFlowlogsPutRequest struct via the builder pattern
pretty
bool
Controls whether the response is pretty-printed (with indentations and new lines).
[default to true]
depth
int32
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
[default to 0]
Return type
HTTP request headers
Content-Type: application/json
Accept: application/json
DatacentersNatgatewaysGet
List NAT Gateways
Example
Path Parameters
ctx
context.Context
context for authentication, logging, cancellation, deadlines, tracing, etc.
datacenterId
string
The unique ID of the data center.
Other Parameters
Other parameters are passed through a pointer to an apiDatacentersNatgatewaysGetRequest struct via the builder pattern
pretty
bool
Controls whether the response is pretty-printed (with indentations and new lines).
[default to true]
depth
int32
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
[default to 0]
xContractNumber
int32
Users with multiple contracts must provide the contract number, for which all API requests are to be executed.
Return type
HTTP request headers
Content-Type: Not defined
Accept: application/json
DatacentersNatgatewaysPatch
Partially modify NAT Gateways
Example
Path Parameters
ctx
context.Context
context for authentication, logging, cancellation, deadlines, tracing, etc.
datacenterId
string
The unique ID of the data center.
natGatewayId
string
The unique ID of the NAT Gateway.
Other Parameters
Other parameters are passed through a pointer to an apiDatacentersNatgatewaysPatchRequest struct via the builder pattern
pretty
bool
Controls whether the response is pretty-printed (with indentations and new lines).
[default to true]
depth
int32
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
[default to 0]
xContractNumber
int32
Users with multiple contracts must provide the contract number, for which all API requests are to be executed.
Return type
HTTP request headers
Content-Type: Not defined
Accept: application/json
DatacentersNatgatewaysPost
Create a NAT Gateway
Example
Path Parameters
ctx
context.Context
context for authentication, logging, cancellation, deadlines, tracing, etc.
datacenterId
string
The unique ID of the data center.
Other Parameters
Other parameters are passed through a pointer to an apiDatacentersNatgatewaysPostRequest struct via the builder pattern
pretty
bool
Controls whether the response is pretty-printed (with indentations and new lines).
[default to true]
depth
int32
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
[default to 0]
xContractNumber
int32
Users with multiple contracts must provide the contract number, for which all API requests are to be executed.
Return type
HTTP request headers
Content-Type: application/json
Accept: application/json
DatacentersNatgatewaysPut
Modify NAT Gateways
Example
Path Parameters
ctx
context.Context
context for authentication, logging, cancellation, deadlines, tracing, etc.
datacenterId
string
The unique ID of the data center.
natGatewayId
string
The unique ID of the NAT Gateway.
Other Parameters
Other parameters are passed through a pointer to an apiDatacentersNatgatewaysPutRequest struct via the builder pattern
pretty
bool
Controls whether the response is pretty-printed (with indentations and new lines).
[default to true]
depth
int32
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
[default to 0]
xContractNumber
int32
Users with multiple contracts must provide the contract number, for which all API requests are to be executed.
Return type
HTTP request headers
Content-Type: application/json
Accept: application/json
DatacentersNatgatewaysRulesDelete
Delete NAT Gateway rules
Example
Path Parameters
ctx
context.Context
context for authentication, logging, cancellation, deadlines, tracing, etc.
datacenterId
string
The unique ID of the data center.
natGatewayId
string
The unique ID of the NAT Gateway.
natGatewayRuleId
string
The unique ID of the NAT Gateway rule.
Other Parameters
Other parameters are passed through a pointer to an apiDatacentersNatgatewaysRulesDeleteRequest struct via the builder pattern
pretty
bool
Controls whether the response is pretty-printed (with indentations and new lines).
[default to true]
depth
int32
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
[default to 0]
xContractNumber
int32
Users with multiple contracts must provide the contract number, for which all API requests are to be executed.
Return type
(empty response body)
HTTP request headers
Content-Type: Not defined
Accept: application/json
DatacentersNatgatewaysRulesFindByNatGatewayRuleId
Retrieve NAT Gateway rules
Example
Path Parameters
ctx
context.Context
context for authentication, logging, cancellation, deadlines, tracing, etc.
datacenterId
string
The unique ID of the data center.
natGatewayId
string
The unique ID of the NAT Gateway.
natGatewayRuleId
string
The unique ID of the NAT Gateway rule.
Other Parameters
Other parameters are passed through a pointer to an apiDatacentersNatgatewaysRulesFindByNatGatewayRuleIdRequest struct via the builder pattern
pretty
bool
Controls whether the response is pretty-printed (with indentations and new lines).
[default to true]
depth
int32
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
[default to 0]
xContractNumber
int32
Users with multiple contracts must provide the contract number, for which all API requests are to be executed.
Return type
HTTP request headers
Content-Type: Not defined
Accept: application/json
DatacentersNatgatewaysRulesGet
List NAT Gateway rules
Example
Path Parameters
ctx
context.Context
context for authentication, logging, cancellation, deadlines, tracing, etc.
datacenterId
string
The unique ID of the data center.
natGatewayId
string
The unique ID of the NAT Gateway.
Other Parameters
Other parameters are passed through a pointer to an apiDatacentersNatgatewaysRulesGetRequest struct via the builder pattern
pretty
bool
Controls whether the response is pretty-printed (with indentations and new lines).
[default to true]
depth
int32
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
[default to 0]
xContractNumber
int32
Users with multiple contracts must provide the contract number, for which all API requests are to be executed.
Return type
HTTP request headers
Content-Type: Not defined
Accept: application/json
DatacentersNatgatewaysRulesPatch
Partially Modify a NAT Gateway Rule by ID
Example
Path Parameters
ctx
context.Context
context for authentication, logging, cancellation, deadlines, tracing, etc.
datacenterId
string
The unique ID of the data center.
natGatewayId
string
The unique ID of the NAT Gateway.
natGatewayRuleId
string
The unique ID of the NAT Gateway rule.
Other Parameters
Other parameters are passed through a pointer to an apiDatacentersNatgatewaysRulesPatchRequest struct via the builder pattern
natGatewayRuleProperties
The properties of the NAT Gateway rule to be updated.
pretty
bool
Controls whether the response is pretty-printed (with indentations and new lines).
[default to true]
depth
int32
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
[default to 0]
xContractNumber
int32
Users with multiple contracts must provide the contract number, for which all API requests are to be executed.
Return type
HTTP request headers
Content-Type: Not defined
Accept: application/json
DatacentersNatgatewaysRulesPost
Create a NAT Gateway Rule
Example
Path Parameters
ctx
context.Context
context for authentication, logging, cancellation, deadlines, tracing, etc.
datacenterId
string
The unique ID of the data center.
natGatewayId
string
The unique ID of the NAT Gateway.
Other Parameters
Other parameters are passed through a pointer to an apiDatacentersNatgatewaysRulesPostRequest struct via the builder pattern
pretty
bool
Controls whether the response is pretty-printed (with indentations and new lines).
[default to true]
depth
int32
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
[default to 0]
xContractNumber
int32
Users with multiple contracts must provide the contract number, for which all API requests are to be executed.
Return type
HTTP request headers
Content-Type: application/json
Accept: application/json
DatacentersNatgatewaysRulesPut
Modify a NAT Gateway Rule by ID
Example
Path Parameters
ctx
context.Context
context for authentication, logging, cancellation, deadlines, tracing, etc.
datacenterId
string
The unique ID of the data center.
natGatewayId
string
The unique ID of the NAT Gateway.
natGatewayRuleId
string
The unique ID of the NAT Gateway rule.
Other Parameters
Other parameters are passed through a pointer to an apiDatacentersNatgatewaysRulesPutRequest struct via the builder pattern
pretty
bool
Controls whether the response is pretty-printed (with indentations and new lines).
[default to true]
depth
int32
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
[default to 0]
xContractNumber
int32
Users with multiple contracts must provide the contract number, for which all API requests are to be executed.
Return type
HTTP request headers
Content-Type: application/json
Accept: application/json
Last updated
