Comment on page

NetworkLoadBalancersApi

All URIs are relative to https://api.ionos.com/cloudapi/v6
Method
HTTP request
Description
​datacentersNetworkloadbalancersDelete​
DELETE /datacenters/{datacenterId}/networkloadbalancers/{networkLoadBalancerId}
Delete Network Load Balancers
​datacentersNetworkloadbalancersFindByNetworkLoadBalancerId​
GET /datacenters/{datacenterId}/networkloadbalancers/{networkLoadBalancerId}
Retrieve Network Load Balancers
​datacentersNetworkloadbalancersFlowlogsDelete​
DELETE /datacenters/{datacenterId}/networkloadbalancers/{networkLoadBalancerId}/flowlogs/{flowLogId}
Delete NLB Flow Logs
​datacentersNetworkloadbalancersFlowlogsFindByFlowLogId​
GET /datacenters/{datacenterId}/networkloadbalancers/{networkLoadBalancerId}/flowlogs/{flowLogId}
Retrieve NLB Flow Logs
​datacentersNetworkloadbalancersFlowlogsGet​
GET /datacenters/{datacenterId}/networkloadbalancers/{networkLoadBalancerId}/flowlogs
List NLB Flow Logs
​datacentersNetworkloadbalancersFlowlogsPatch​
PATCH /datacenters/{datacenterId}/networkloadbalancers/{networkLoadBalancerId}/flowlogs/{flowLogId}
Partially modify NLB Flow Logs
​datacentersNetworkloadbalancersFlowlogsPost​
POST /datacenters/{datacenterId}/networkloadbalancers/{networkLoadBalancerId}/flowlogs
Create a NLB Flow Log
​datacentersNetworkloadbalancersFlowlogsPut​
PUT /datacenters/{datacenterId}/networkloadbalancers/{networkLoadBalancerId}/flowlogs/{flowLogId}
Modify NLB Flow Logs
​datacentersNetworkloadbalancersForwardingrulesDelete​
DELETE /datacenters/{datacenterId}/networkloadbalancers/{networkLoadBalancerId}/forwardingrules/{forwardingRuleId}
Delete NLB forwarding rules
​datacentersNetworkloadbalancersForwardingrulesFindByForwardingRuleId​
GET /datacenters/{datacenterId}/networkloadbalancers/{networkLoadBalancerId}/forwardingrules/{forwardingRuleId}
Retrieve NLB forwarding rules
​datacentersNetworkloadbalancersForwardingrulesGet​
GET /datacenters/{datacenterId}/networkloadbalancers/{networkLoadBalancerId}/forwardingrules
List NLB forwarding rules
​datacentersNetworkloadbalancersForwardingrulesPatch​
PATCH /datacenters/{datacenterId}/networkloadbalancers/{networkLoadBalancerId}/forwardingrules/{forwardingRuleId}
Partially modify NLB forwarding rules
​datacentersNetworkloadbalancersForwardingrulesPost​
POST /datacenters/{datacenterId}/networkloadbalancers/{networkLoadBalancerId}/forwardingrules
Create a NLB Forwarding Rule
​datacentersNetworkloadbalancersForwardingrulesPut​
PUT /datacenters/{datacenterId}/networkloadbalancers/{networkLoadBalancerId}/forwardingrules/{forwardingRuleId}
Modify NLB forwarding rules
​datacentersNetworkloadbalancersGet​
GET /datacenters/{datacenterId}/networkloadbalancers
List Network Load Balancers
​datacentersNetworkloadbalancersPatch​
PATCH /datacenters/{datacenterId}/networkloadbalancers/{networkLoadBalancerId}
Partially modify Network Load Balancers
​datacentersNetworkloadbalancersPost​
POST /datacenters/{datacenterId}/networkloadbalancers
Create a Network Load Balancer
​datacentersNetworkloadbalancersPut​
PUT /datacenters/{datacenterId}/networkloadbalancers/{networkLoadBalancerId}
Modify Network Load Balancers
datacentersNetworkloadbalancersDelete
datacentersNetworkloadbalancersDelete(datacenterId, networkLoadBalancerId, opts)
Delete Network Load Balancers
Remove the specified Network Load Balancer 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.NetworkLoadBalancersApi(config);
// Delete Network Load Balancers
api_instance
  .datacentersNetworkloadbalancersDelete({
    datacenterId: datacenterId_example,
    networkLoadBalancerId: networkLoadBalancerId_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]
networkLoadBalancerId
string
The unique ID of the Network Load Balancer.
[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
datacentersNetworkloadbalancersFindByNetworkLoadBalancerId
datacentersNetworkloadbalancersFindByNetworkLoadBalancerId(datacenterId, networkLoadBalancerId, opts)
Retrieve Network Load Balancers
Retrieve the properties of the specified Network Load Balancer 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.NetworkLoadBalancersApi(config);
// Retrieve Network Load Balancers
api_instance
  .datacentersNetworkloadbalancersFindByNetworkLoadBalancerId({
    datacenterId: datacenterId_example,
    networkLoadBalancerId: networkLoadBalancerId_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]
networkLoadBalancerId
string
The unique ID of the Network Load Balancer.
[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
​NetworkLoadBalancer​
Authorization
Basic Authentication, Token Authentication
HTTP request headers
Content-Type: Not defined
Accept: application/json
datacentersNetworkloadbalancersFlowlogsDelete
datacentersNetworkloadbalancersFlowlogsDelete(datacenterId, networkLoadBalancerId, flowLogId, opts)
Delete NLB Flow Logs
Delete the specified Network Load Balancer 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.NetworkLoadBalancersApi(config);
// Delete NLB Flow Logs
api_instance
  .datacentersNetworkloadbalancersFlowlogsDelete({
    datacenterId: datacenterId_example,
    networkLoadBalancerId: networkLoadBalancerId_example,
    flowLogId: flowLogId_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]
networkLoadBalancerId
string
The unique ID of the Network Load Balancer.
[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]
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
datacentersNetworkloadbalancersFlowlogsFindByFlowLogId
datacentersNetworkloadbalancersFlowlogsFindByFlowLogId(datacenterId, networkLoadBalancerId, flowLogId, opts)
Retrieve NLB Flow Logs
Retrieve the specified Network Load Balancer 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.NetworkLoadBalancersApi(config);
// Retrieve NLB Flow Logs
api_instance
  .datacentersNetworkloadbalancersFlowlogsFindByFlowLogId({
    datacenterId: datacenterId_example,
    networkLoadBalancerId: networkLoadBalancerId_example,
    flowLogId: flowLogId_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]
networkLoadBalancerId
string
The unique ID of the Network Load Balancer.
[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]
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
​FlowLog​
Authorization
Basic Authentication, Token Authentication
HTTP request headers
Content-Type: Not defined
Accept: application/json
datacentersNetworkloadbalancersFlowlogsGet
datacentersNetworkloadbalancersFlowlogsGet(datacenterId, networkLoadBalancerId, opts)
List NLB Flow Logs
List all the Flow Logs for the specified Network Load Balancer.
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.NetworkLoadBalancersApi(config);
var filterMap = new Map()
filterMap.set("<property_name>", "<property_value>")
// List NLB Flow Logs
api_instance
  .datacentersNetworkloadbalancersFlowlogsGet({
    datacenterId: datacenterId_example,
    networkLoadBalancerId: networkLoadBalancerId_example,
    pretty: true,
    depth: 56,
    xContractNumber: 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]
networkLoadBalancerId
string
The unique ID of the Network Load Balancer.
[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
​FlowLogs​
Authorization
Basic Authentication, Token Authentication
HTTP request headers
Content-Type: Not defined
Accept: application/json
datacentersNetworkloadbalancersFlowlogsPatch
datacentersNetworkloadbalancersFlowlogsPatch(datacenterId, networkLoadBalancerId, flowLogId, networkLoadBalancerFlowLogProperties, opts)
Partially modify NLB Flow Logs
Update the properties of the specified Network Load Balancer 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.NetworkLoadBalancersApi(config);
// Partially modify NLB Flow Logs
api_instance
  .datacentersNetworkloadbalancersFlowlogsPatch({
    datacenterId: datacenterId_example,
    networkLoadBalancerId: networkLoadBalancerId_example,
    flowLogId: flowLogId_example,
    networkLoadBalancerFlowLogProperties: networkLoadBalancerFlowLogProperties_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]
networkLoadBalancerId
string
The unique ID of the Network Load Balancer.
[default to undefined]
flowLogId
string
The unique ID of the Flow Log.
[default to undefined]
networkLoadBalancerFlowLogProperties
​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]
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
​FlowLog​
Authorization
Basic Authentication, Token Authentication
HTTP request headers
Content-Type: Not defined
Accept: application/json
datacentersNetworkloadbalancersFlowlogsPost
datacentersNetworkloadbalancersFlowlogsPost(datacenterId, networkLoadBalancerId, networkLoadBalancerFlowLog, opts)
Create a NLB Flow Log
Adds a new Flow Log for the Network Load Balancer.
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.NetworkLoadBalancersApi(config);
// Create a NLB Flow Log
api_instance
  .datacentersNetworkloadbalancersFlowlogsPost({
    datacenterId: datacenterId_example,
    networkLoadBalancerId: networkLoadBalancerId_example,
    networkLoadBalancerFlowLog: networkLoadBalancerFlowLog_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]
networkLoadBalancerId
string
The unique ID of the Network Load Balancer.
[default to undefined]
networkLoadBalancerFlowLog
​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]
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
​FlowLog​
Authorization
Basic Authentication, Token Authentication
HTTP request headers
Content-Type: application/json
Accept: application/json
datacentersNetworkloadbalancersFlowlogsPut
datacentersNetworkloadbalancersFlowlogsPut(datacenterId, networkLoadBalancerId, flowLogId, networkLoadBalancerFlowLog, opts)
Modify NLB Flow Logs
Modify the specified Network Load Balancer 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.NetworkLoadBalancersApi(config);
// Modify NLB Flow Logs
api_instance
  .datacentersNetworkloadbalancersFlowlogsPut({
    datacenterId: datacenterId_example,
    networkLoadBalancerId: networkLoadBalancerId_example,
    flowLogId: flowLogId_example,
    networkLoadBalancerFlowLog: networkLoadBalancerFlowLog_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]
networkLoadBalancerId
string
The unique ID of the Network Load Balancer.
[default to undefined]
flowLogId
string
The unique ID of the Flow Log.
[default to undefined]
networkLoadBalancerFlowLog
​FlowLogPut​
The modified NLB 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]
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
​FlowLog​
Authorization
Basic Authentication, Token Authentication
HTTP request headers

Method	HTTP request	Description
datacentersNetworkloadbalancersDelete	DELETE /datacenters/{datacenterId}/networkloadbalancers/{networkLoadBalancerId}	Delete Network Load Balancers
datacentersNetworkloadbalancersFindByNetworkLoadBalancerId	GET /datacenters/{datacenterId}/networkloadbalancers/{networkLoadBalancerId}	Retrieve Network Load Balancers
datacentersNetworkloadbalancersFlowlogsDelete	DELETE /datacenters/{datacenterId}/networkloadbalancers/{networkLoadBalancerId}/flowlogs/{flowLogId}	Delete NLB Flow Logs
datacentersNetworkloadbalancersFlowlogsFindByFlowLogId	GET /datacenters/{datacenterId}/networkloadbalancers/{networkLoadBalancerId}/flowlogs/{flowLogId}	Retrieve NLB Flow Logs
datacentersNetworkloadbalancersFlowlogsGet	GET /datacenters/{datacenterId}/networkloadbalancers/{networkLoadBalancerId}/flowlogs	List NLB Flow Logs
datacentersNetworkloadbalancersFlowlogsPatch	PATCH /datacenters/{datacenterId}/networkloadbalancers/{networkLoadBalancerId}/flowlogs/{flowLogId}	Partially modify NLB Flow Logs
datacentersNetworkloadbalancersFlowlogsPost	POST /datacenters/{datacenterId}/networkloadbalancers/{networkLoadBalancerId}/flowlogs	Create a NLB Flow Log
datacentersNetworkloadbalancersFlowlogsPut	PUT /datacenters/{datacenterId}/networkloadbalancers/{networkLoadBalancerId}/flowlogs/{flowLogId}	Modify NLB Flow Logs
datacentersNetworkloadbalancersForwardingrulesDelete	DELETE /datacenters/{datacenterId}/networkloadbalancers/{networkLoadBalancerId}/forwardingrules/{forwardingRuleId}	Delete NLB forwarding rules
datacentersNetworkloadbalancersForwardingrulesFindByForwardingRuleId	GET /datacenters/{datacenterId}/networkloadbalancers/{networkLoadBalancerId}/forwardingrules/{forwardingRuleId}	Retrieve NLB forwarding rules
datacentersNetworkloadbalancersForwardingrulesGet	GET /datacenters/{datacenterId}/networkloadbalancers/{networkLoadBalancerId}/forwardingrules	List NLB forwarding rules
datacentersNetworkloadbalancersForwardingrulesPatch	PATCH /datacenters/{datacenterId}/networkloadbalancers/{networkLoadBalancerId}/forwardingrules/{forwardingRuleId}	Partially modify NLB forwarding rules
datacentersNetworkloadbalancersForwardingrulesPost	POST /datacenters/{datacenterId}/networkloadbalancers/{networkLoadBalancerId}/forwardingrules	Create a NLB Forwarding Rule
datacentersNetworkloadbalancersForwardingrulesPut	PUT /datacenters/{datacenterId}/networkloadbalancers/{networkLoadBalancerId}/forwardingrules/{forwardingRuleId}	Modify NLB forwarding rules
datacentersNetworkloadbalancersGet	GET /datacenters/{datacenterId}/networkloadbalancers	List Network Load Balancers
datacentersNetworkloadbalancersPatch	PATCH /datacenters/{datacenterId}/networkloadbalancers/{networkLoadBalancerId}	Partially modify Network Load Balancers
datacentersNetworkloadbalancersPost	POST /datacenters/{datacenterId}/networkloadbalancers	Create a Network Load Balancer
datacentersNetworkloadbalancersPut	PUT /datacenters/{datacenterId}/networkloadbalancers/{networkLoadBalancerId}	Modify Network Load Balancers

Name	Type	Description	Notes
datacenterId	string	The unique ID of the data center.	[default to undefined]
networkLoadBalancerId	string	The unique ID of the Network Load Balancer.	[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]