Comment on page

NATGatewaysApi

All URIs are relative to https://api.ionos.com/cloudapi/v6
Method
HTTP request
Description
​datacentersNatgatewaysDelete​
DELETE /datacenters/{datacenterId}/natgateways/{natGatewayId}
Delete NAT Gateways
​datacentersNatgatewaysFindByNatGatewayId​
GET /datacenters/{datacenterId}/natgateways/{natGatewayId}
Retrieve NAT Gateways
​datacentersNatgatewaysFlowlogsDelete​
DELETE /datacenters/{datacenterId}/natgateways/{natGatewayId}/flowlogs/{flowLogId}
Delete NAT Gateway Flow Logs
​datacentersNatgatewaysFlowlogsFindByFlowLogId​
GET /datacenters/{datacenterId}/natgateways/{natGatewayId}/flowlogs/{flowLogId}
Retrieve NAT Gateway Flow Logs
​datacentersNatgatewaysFlowlogsGet​
GET /datacenters/{datacenterId}/natgateways/{natGatewayId}/flowlogs
List NAT Gateway Flow Logs
​datacentersNatgatewaysFlowlogsPatch​
PATCH /datacenters/{datacenterId}/natgateways/{natGatewayId}/flowlogs/{flowLogId}
Partially modify NAT Gateway Flow Logs
​datacentersNatgatewaysFlowlogsPost​
POST /datacenters/{datacenterId}/natgateways/{natGatewayId}/flowlogs
Create a NAT Gateway Flow Log
​datacentersNatgatewaysFlowlogsPut​
PUT /datacenters/{datacenterId}/natgateways/{natGatewayId}/flowlogs/{flowLogId}
Modify NAT Gateway Flow Logs
​datacentersNatgatewaysGet​
GET /datacenters/{datacenterId}/natgateways
List NAT Gateways
​datacentersNatgatewaysPatch​
PATCH /datacenters/{datacenterId}/natgateways/{natGatewayId}
Partially modify NAT Gateways
​datacentersNatgatewaysPost​
POST /datacenters/{datacenterId}/natgateways
Create a NAT Gateway
​datacentersNatgatewaysPut​
PUT /datacenters/{datacenterId}/natgateways/{natGatewayId}
Modify NAT Gateways
​datacentersNatgatewaysRulesDelete​
DELETE /datacenters/{datacenterId}/natgateways/{natGatewayId}/rules/{natGatewayRuleId}
Delete NAT Gateway rules
​datacentersNatgatewaysRulesFindByNatGatewayRuleId​
GET /datacenters/{datacenterId}/natgateways/{natGatewayId}/rules/{natGatewayRuleId}
Retrieve NAT Gateway rules
​datacentersNatgatewaysRulesGet​
GET /datacenters/{datacenterId}/natgateways/{natGatewayId}/rules
List NAT Gateway rules
​datacentersNatgatewaysRulesPatch​
PATCH /datacenters/{datacenterId}/natgateways/{natGatewayId}/rules/{natGatewayRuleId}
Partially Modify a NAT Gateway Rule by ID
​datacentersNatgatewaysRulesPost​
POST /datacenters/{datacenterId}/natgateways/{natGatewayId}/rules
Create a NAT Gateway Rule
​datacentersNatgatewaysRulesPut​
PUT /datacenters/{datacenterId}/natgateways/{natGatewayId}/rules/{natGatewayRuleId}
Modify a NAT Gateway Rule by ID
datacentersNatgatewaysDelete
datacentersNatgatewaysDelete(datacenterId, natGatewayId, opts)
Delete NAT Gateways
Remove the specified NAT Gateway from the data center.
Examples
const ionoscloud = require('@ionos-cloud/sdk-nodejs');
// setup authorization
const config = new ionoscloud.Configuration({
    username: 'YOUR_USERNAME',
    password: 'YOUR_PASSWORD',
    apiKey: 'YOUR_API_KEY'
});
const api_instance = new ionoscloud.NATGatewaysApi(config);
// Delete NAT Gateways
api_instance
  .datacentersNatgatewaysDelete({
    datacenterId: datacenterId_example,
    natGatewayId: natGatewayId_example,
    pretty: true,
    depth: 56,
    xContractNumber: 56, 
        options: {}
  })
  .then((response) => console.log(response.data))
  .catch((error) => console.log(error.response.data));
Parameters
Name
Type
Description
Notes
datacenterId
string
The unique ID of the data center.
[default to undefined]
natGatewayId
string
The unique ID of the NAT Gateway.
[default to undefined]
pretty
boolean
Controls whether the response is pretty-printed (with indentations and new lines).
[optional][default to true]
depth
number
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&#39;s children are included. - depth=... and so on
[optional][default to 0]
xContractNumber
number
Users with multiple contracts must provide the contract number, for which all API requests are to be executed.
[optional][default to undefined]
Return type
nil (empty response body)
Authorization
Basic Authentication, Token Authentication
HTTP request headers
Content-Type: Not defined
Accept: application/json
datacentersNatgatewaysFindByNatGatewayId
datacentersNatgatewaysFindByNatGatewayId(datacenterId, natGatewayId, opts)
Retrieve NAT Gateways
Retrieve the properties of the specified NAT Gateway within the data center.
Examples
const ionoscloud = require('@ionos-cloud/sdk-nodejs');
// setup authorization
const config = new ionoscloud.Configuration({
    username: 'YOUR_USERNAME',
    password: 'YOUR_PASSWORD',
    apiKey: 'YOUR_API_KEY'
});
const api_instance = new ionoscloud.NATGatewaysApi(config);
// Retrieve NAT Gateways
api_instance
  .datacentersNatgatewaysFindByNatGatewayId({
    datacenterId: datacenterId_example,
    natGatewayId: natGatewayId_example,
    pretty: true,
    depth: 56,
    xContractNumber: 56, 
        options: {}
  })
  .then((response) => console.log(response.data))
  .catch((error) => console.log(error.response.data));
Parameters
Name
Type
Description
Notes
datacenterId
string
The unique ID of the data center.
[default to undefined]
natGatewayId
string
The unique ID of the NAT Gateway.
[default to undefined]
pretty
boolean
Controls whether the response is pretty-printed (with indentations and new lines).
[optional][default to true]
depth
number
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&#39;s children are included. - depth=... and so on
[optional][default to 0]
xContractNumber
number
Users with multiple contracts must provide the contract number, for which all API requests are to be executed.
[optional][default to undefined]
Return type
​NatGateway​
Authorization
Basic Authentication, Token Authentication
HTTP request headers
Content-Type: Not defined
Accept: application/json
datacentersNatgatewaysFlowlogsDelete
datacentersNatgatewaysFlowlogsDelete(datacenterId, natGatewayId, flowLogId, opts)
Delete NAT Gateway Flow Logs
Delete the specified NAT Gateway Flow Log.
Examples
const ionoscloud = require('@ionos-cloud/sdk-nodejs');
// setup authorization
const config = new ionoscloud.Configuration({
    username: 'YOUR_USERNAME',
    password: 'YOUR_PASSWORD',
    apiKey: 'YOUR_API_KEY'
});
const api_instance = new ionoscloud.NATGatewaysApi(config);
// Delete NAT Gateway Flow Logs
api_instance
  .datacentersNatgatewaysFlowlogsDelete({
    datacenterId: datacenterId_example,
    natGatewayId: natGatewayId_example,
    flowLogId: flowLogId_example,
    pretty: true,
    depth: 56, 
        options: {}
  })
  .then((response) => console.log(response.data))
  .catch((error) => console.log(error.response.data));
Parameters
Name
Type
Description
Notes
datacenterId
string
The unique ID of the data center.
[default to undefined]
natGatewayId
string
The unique ID of the NAT Gateway.
[default to undefined]
flowLogId
string
The unique ID of the Flow Log.
[default to undefined]
pretty
boolean
Controls whether the response is pretty-printed (with indentations and new lines).
[optional][default to true]
depth
number
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&#39;s children are included. - depth=... and so on
[optional][default to 0]
Return type
nil (empty response body)
Authorization
Basic Authentication, Token Authentication
HTTP request headers
Content-Type: Not defined
Accept: application/json
datacentersNatgatewaysFlowlogsFindByFlowLogId
datacentersNatgatewaysFlowlogsFindByFlowLogId(datacenterId, natGatewayId, flowLogId, opts)
Retrieve NAT Gateway Flow Logs
Retrieve the specified NAT Gateway Flow Log.
Examples
const ionoscloud = require('@ionos-cloud/sdk-nodejs');
// setup authorization
const config = new ionoscloud.Configuration({
    username: 'YOUR_USERNAME',
    password: 'YOUR_PASSWORD',
    apiKey: 'YOUR_API_KEY'
});
const api_instance = new ionoscloud.NATGatewaysApi(config);
// Retrieve NAT Gateway Flow Logs
api_instance
  .datacentersNatgatewaysFlowlogsFindByFlowLogId({
    datacenterId: datacenterId_example,
    natGatewayId: natGatewayId_example,
    flowLogId: flowLogId_example,
    pretty: true,
    depth: 56, 
        options: {}
  })
  .then((response) => console.log(response.data))
  .catch((error) => console.log(error.response.data));
Parameters
Name
Type
Description
Notes
datacenterId
string
The unique ID of the data center.
[default to undefined]
natGatewayId
string
The unique ID of the NAT Gateway.
[default to undefined]
flowLogId
string
The unique ID of the Flow Log.
[default to undefined]
pretty
boolean
Controls whether the response is pretty-printed (with indentations and new lines).
[optional][default to true]
depth
number
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&#39;s children are included. - depth=... and so on
[optional][default to 0]
Return type
​FlowLog​
Authorization
Basic Authentication, Token Authentication
HTTP request headers
Content-Type: Not defined
Accept: application/json
datacentersNatgatewaysFlowlogsGet
datacentersNatgatewaysFlowlogsGet(datacenterId, natGatewayId, opts)
List NAT Gateway Flow Logs
List all the Flow Logs for the specified NAT Gateway.
Examples
const ionoscloud = require('@ionos-cloud/sdk-nodejs');
// setup authorization
const config = new ionoscloud.Configuration({
    username: 'YOUR_USERNAME',
    password: 'YOUR_PASSWORD',
    apiKey: 'YOUR_API_KEY'
});
const api_instance = new ionoscloud.NATGatewaysApi(config);
var filterMap = new Map()
filterMap.set("<property_name>", "<property_value>")
// List NAT Gateway Flow Logs
api_instance
  .datacentersNatgatewaysFlowlogsGet({
    datacenterId: datacenterId_example,
    natGatewayId: natGatewayId_example,
    pretty: true,
    depth: 56,
    offset: 56,
    limit: 56, 
    orderBy: "<property_name>"
    maxResults: 2,
    filters: filterMap
    options: {}
  })
  .then((response) => console.log(response.data))
  .catch((error) => console.log(error.response.data));
Parameters
Name
Type
Description
Notes
datacenterId
string
The unique ID of the data center.
[default to undefined]
natGatewayId
string
The unique ID of the NAT Gateway.
[default to undefined]
pretty
boolean
Controls whether the response is pretty-printed (with indentations and new lines).
[optional][default to true]
depth
number
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&#39;s children are included. - depth=... and so on
[optional][default to 0]
offset
number
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
number
The maximum number of elements to return (use together with offset for pagination).
[optional][default to 1000]
Return type
​FlowLogs​
Authorization
Basic Authentication, Token Authentication
HTTP request headers
Content-Type: Not defined
Accept: application/json
datacentersNatgatewaysFlowlogsPatch
datacentersNatgatewaysFlowlogsPatch(datacenterId, natGatewayId, flowLogId, natGatewayFlowLogProperties, opts)
Partially modify NAT Gateway Flow Logs
Update the properties of the specified NAT Gateway Flow Log.
Examples
const ionoscloud = require('@ionos-cloud/sdk-nodejs');
// setup authorization
const config = new ionoscloud.Configuration({
    username: 'YOUR_USERNAME',
    password: 'YOUR_PASSWORD',
    apiKey: 'YOUR_API_KEY'
});
const api_instance = new ionoscloud.NATGatewaysApi(config);
// Partially modify NAT Gateway Flow Logs
api_instance
  .datacentersNatgatewaysFlowlogsPatch({
    datacenterId: datacenterId_example,
    natGatewayId: natGatewayId_example,
    flowLogId: flowLogId_example,
    natGatewayFlowLogProperties: natGatewayFlowLogProperties_example,
    pretty: true,
    depth: 56, 
        options: {}
  })
  .then((response) => console.log(response.data))
  .catch((error) => console.log(error.response.data));
Parameters
Name
Type
Description
Notes
datacenterId
string
The unique ID of the data center.
[default to undefined]
natGatewayId
string
The unique ID of the NAT Gateway.
[default to undefined]
flowLogId
string
The unique ID of the Flow Log.
[default to undefined]
natGatewayFlowLogProperties
​FlowLogProperties​
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
number
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&#39;s children are included. - depth=... and so on
[optional][default to 0]
Return type
​FlowLog​
Authorization
Basic Authentication, Token Authentication
HTTP request headers
Content-Type: Not defined
Accept: application/json
datacentersNatgatewaysFlowlogsPost
datacentersNatgatewaysFlowlogsPost(datacenterId, natGatewayId, natGatewayFlowLog, opts)
Create a NAT Gateway Flow Log
Adds a new Flow Log to the specified NAT Gateway.
Examples
const ionoscloud = require('@ionos-cloud/sdk-nodejs');
// setup authorization
const config = new ionoscloud.Configuration({
    username: 'YOUR_USERNAME',
    password: 'YOUR_PASSWORD',
    apiKey: 'YOUR_API_KEY'
});
const api_instance = new ionoscloud.NATGatewaysApi(config);
// Create a NAT Gateway Flow Log
api_instance
  .datacentersNatgatewaysFlowlogsPost({
    datacenterId: datacenterId_example,
    natGatewayId: natGatewayId_example,
    natGatewayFlowLog: natGatewayFlowLog_example,
    pretty: true,
    depth: 56, 
        options: {}
  })
  .then((response) => console.log(response.data))
  .catch((error) => console.log(error.response.data));
Parameters
Name
Type
Description
Notes
datacenterId
string
The unique ID of the data center.
[default to undefined]
natGatewayId
string
The unique ID of the NAT Gateway.
[default to undefined]
natGatewayFlowLog
​FlowLog​
The Flow Log to create.
​
pretty
boolean
Controls whether the response is pretty-printed (with indentations and new lines).
[optional][default to true]
depth
number
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&#39;s children are included. - depth=... and so on
[optional][default to 0]
Return type
​FlowLog​
Authorization
Basic Authentication, Token Authentication
HTTP request headers
Content-Type: application/json
Accept: application/json
datacentersNatgatewaysFlowlogsPut
datacentersNatgatewaysFlowlogsPut(datacenterId, natGatewayId, flowLogId, natGatewayFlowLog, opts)
Modify NAT Gateway Flow Logs
Modify the specified NAT Gateway Flow Log.
Examples
const ionoscloud = require('@ionos-cloud/sdk-nodejs');
// setup authorization
const config = new ionoscloud.Configuration({
    username: 'YOUR_USERNAME',
    password: 'YOUR_PASSWORD',
    apiKey: 'YOUR_API_KEY'
});
const api_instance = new ionoscloud.NATGatewaysApi(config);
// Modify NAT Gateway Flow Logs
api_instance
  .datacentersNatgatewaysFlowlogsPut({
    datacenterId: datacenterId_example,
    natGatewayId: natGatewayId_example,
    flowLogId: flowLogId_example,
    natGatewayFlowLog: natGatewayFlowLog_example,
    pretty: true,
    depth: 56, 
        options: {}
  })
  .then((response) => console.log(response.data))
  .catch((error) => console.log(error.response.data));
Parameters
Name
Type
Description
Notes
datacenterId
string
The unique ID of the data center.
[default to undefined]
natGatewayId
string
The unique ID of the NAT Gateway.
[default to undefined]
flowLogId
string
The unique ID of the Flow Log.
[default to undefined]
natGatewayFlowLog
​FlowLogPut​
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
number
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&#39;s children are included. - depth=... and so on
[optional][default to 0]
Return type
​FlowLog​
Authorization
Basic Authentication, Token Authentication
HTTP request headers
Content-Type: application/json
Accept: application/json
datacentersNatgatewaysGet
datacentersNatgatewaysGet(datacenterId, opts)
List NAT Gateways
List all NAT Gateways within the data center.
Examples
const ionoscloud = require('@ionos-cloud/sdk-nodejs');
// setup authorization
const config = new ionoscloud.Configuration({
    username: 'YOUR_USERNAME',
    password: 'YOUR_PASSWORD',
    apiKey: 'YOUR_API_KEY'
});
const api_instance = new ionoscloud.NATGatewaysApi(config);
var filterMap = new Map()
filterMap.set("<property_name>", "<property_value>")
// List NAT Gateways
api_instance
  .datacentersNatgatewaysGet({
    datacenterId: datacenterId_example,

Method	HTTP request	Description
datacentersNatgatewaysDelete	DELETE /datacenters/{datacenterId}/natgateways/{natGatewayId}	Delete NAT Gateways
datacentersNatgatewaysFindByNatGatewayId	GET /datacenters/{datacenterId}/natgateways/{natGatewayId}	Retrieve NAT Gateways
datacentersNatgatewaysFlowlogsDelete	DELETE /datacenters/{datacenterId}/natgateways/{natGatewayId}/flowlogs/{flowLogId}	Delete NAT Gateway Flow Logs
datacentersNatgatewaysFlowlogsFindByFlowLogId	GET /datacenters/{datacenterId}/natgateways/{natGatewayId}/flowlogs/{flowLogId}	Retrieve NAT Gateway Flow Logs
datacentersNatgatewaysFlowlogsGet	GET /datacenters/{datacenterId}/natgateways/{natGatewayId}/flowlogs	List NAT Gateway Flow Logs
datacentersNatgatewaysFlowlogsPatch	PATCH /datacenters/{datacenterId}/natgateways/{natGatewayId}/flowlogs/{flowLogId}	Partially modify NAT Gateway Flow Logs
datacentersNatgatewaysFlowlogsPost	POST /datacenters/{datacenterId}/natgateways/{natGatewayId}/flowlogs	Create a NAT Gateway Flow Log
datacentersNatgatewaysFlowlogsPut	PUT /datacenters/{datacenterId}/natgateways/{natGatewayId}/flowlogs/{flowLogId}	Modify NAT Gateway Flow Logs
datacentersNatgatewaysGet	GET /datacenters/{datacenterId}/natgateways	List NAT Gateways
datacentersNatgatewaysPatch	PATCH /datacenters/{datacenterId}/natgateways/{natGatewayId}	Partially modify NAT Gateways
datacentersNatgatewaysPost	POST /datacenters/{datacenterId}/natgateways	Create a NAT Gateway
datacentersNatgatewaysPut	PUT /datacenters/{datacenterId}/natgateways/{natGatewayId}	Modify NAT Gateways
datacentersNatgatewaysRulesDelete	DELETE /datacenters/{datacenterId}/natgateways/{natGatewayId}/rules/{natGatewayRuleId}	Delete NAT Gateway rules
datacentersNatgatewaysRulesFindByNatGatewayRuleId	GET /datacenters/{datacenterId}/natgateways/{natGatewayId}/rules/{natGatewayRuleId}	Retrieve NAT Gateway rules
datacentersNatgatewaysRulesGet	GET /datacenters/{datacenterId}/natgateways/{natGatewayId}/rules	List NAT Gateway rules
datacentersNatgatewaysRulesPatch	PATCH /datacenters/{datacenterId}/natgateways/{natGatewayId}/rules/{natGatewayRuleId}	Partially Modify a NAT Gateway Rule by ID
datacentersNatgatewaysRulesPost	POST /datacenters/{datacenterId}/natgateways/{natGatewayId}/rules	Create a NAT Gateway Rule
datacentersNatgatewaysRulesPut	PUT /datacenters/{datacenterId}/natgateways/{natGatewayId}/rules/{natGatewayRuleId}	Modify a NAT Gateway Rule by ID

Name	Type	Description	Notes
datacenterId	string	The unique ID of the data center.	[default to undefined]
natGatewayId	string	The unique ID of the NAT Gateway.	[default to undefined]
pretty	boolean	Controls whether the response is pretty-printed (with indentations and new lines).	[optional][default to true]
depth	number	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]
xContractNumber	number	Users with multiple contracts must provide the contract number, for which all API requests are to be executed.	[optional][default to undefined]