NetworkLoadBalancersApi
All URIs are relative to https://api.ionos.com/cloudapi/v6
Delete /datacenters/{datacenterId}/networkloadbalancers/{networkLoadBalancerId}
Delete Network Load Balancers
Get /datacenters/{datacenterId}/networkloadbalancers/{networkLoadBalancerId}
Retrieve Network Load Balancers
Delete /datacenters/{datacenterId}/networkloadbalancers/{networkLoadBalancerId}/flowlogs/{flowLogId}
Delete NLB Flow Logs
Get /datacenters/{datacenterId}/networkloadbalancers/{networkLoadBalancerId}/flowlogs/{flowLogId}
Retrieve NLB Flow Logs
Get /datacenters/{datacenterId}/networkloadbalancers/{networkLoadBalancerId}/flowlogs
List NLB Flow Logs
Patch /datacenters/{datacenterId}/networkloadbalancers/{networkLoadBalancerId}/flowlogs/{flowLogId}
Partially modify NLB Flow Logs
Post /datacenters/{datacenterId}/networkloadbalancers/{networkLoadBalancerId}/flowlogs
Create a NLB Flow Log
Put /datacenters/{datacenterId}/networkloadbalancers/{networkLoadBalancerId}/flowlogs/{flowLogId}
Modify NLB Flow Logs
Delete /datacenters/{datacenterId}/networkloadbalancers/{networkLoadBalancerId}/forwardingrules/{forwardingRuleId}
Delete NLB forwarding rules
Get /datacenters/{datacenterId}/networkloadbalancers/{networkLoadBalancerId}/forwardingrules/{forwardingRuleId}
Retrieve NLB forwarding rules
Get /datacenters/{datacenterId}/networkloadbalancers/{networkLoadBalancerId}/forwardingrules
List NLB forwarding rules
Patch /datacenters/{datacenterId}/networkloadbalancers/{networkLoadBalancerId}/forwardingrules/{forwardingRuleId}
Partially modify NLB forwarding rules
Post /datacenters/{datacenterId}/networkloadbalancers/{networkLoadBalancerId}/forwardingrules
Create a NLB Forwarding Rule
Put /datacenters/{datacenterId}/networkloadbalancers/{networkLoadBalancerId}/forwardingrules/{forwardingRuleId}
Modify NLB forwarding rules
Get /datacenters/{datacenterId}/networkloadbalancers
List Network Load Balancers
Patch /datacenters/{datacenterId}/networkloadbalancers/{networkLoadBalancerId}
Partially modify Network Load Balancers
Post /datacenters/{datacenterId}/networkloadbalancers
Create a Network Load Balancer
Put /datacenters/{datacenterId}/networkloadbalancers/{networkLoadBalancerId}
Modify Network Load Balancers
DatacentersNetworkloadbalancersDelete
Delete Network Load Balancers
Example
Path Parameters
ctx
context.Context
context for authentication, logging, cancellation, deadlines, tracing, etc.
datacenterId
string
The unique ID of the data center.
networkLoadBalancerId
string
The unique ID of the Network Load Balancer.
Other Parameters
Other parameters are passed through a pointer to an apiDatacentersNetworkloadbalancersDeleteRequest 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
DatacentersNetworkloadbalancersFindByNetworkLoadBalancerId
Retrieve Network Load Balancers
Example
Path Parameters
ctx
context.Context
context for authentication, logging, cancellation, deadlines, tracing, etc.
datacenterId
string
The unique ID of the data center.
networkLoadBalancerId
string
The unique ID of the Network Load Balancer.
Other Parameters
Other parameters are passed through a pointer to an apiDatacentersNetworkloadbalancersFindByNetworkLoadBalancerIdRequest 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
DatacentersNetworkloadbalancersFlowlogsDelete
Delete NLB 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.
networkLoadBalancerId
string
The unique ID of the Network Load Balancer.
flowLogId
string
The unique ID of the Flow Log.
Other Parameters
Other parameters are passed through a pointer to an apiDatacentersNetworkloadbalancersFlowlogsDeleteRequest 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
DatacentersNetworkloadbalancersFlowlogsFindByFlowLogId
Retrieve NLB 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.
networkLoadBalancerId
string
The unique ID of the Network Load Balancer.
flowLogId
string
The unique ID of the Flow Log.
Other Parameters
Other parameters are passed through a pointer to an apiDatacentersNetworkloadbalancersFlowlogsFindByFlowLogIdRequest 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
DatacentersNetworkloadbalancersFlowlogsGet
List NLB 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.
networkLoadBalancerId
string
The unique ID of the Network Load Balancer.
Other Parameters
Other parameters are passed through a pointer to an apiDatacentersNetworkloadbalancersFlowlogsGetRequest 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
DatacentersNetworkloadbalancersFlowlogsPatch
Partially modify NLB 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.
networkLoadBalancerId
string
The unique ID of the Network Load Balancer.
flowLogId
string
The unique ID of the Flow Log.
Other Parameters
Other parameters are passed through a pointer to an apiDatacentersNetworkloadbalancersFlowlogsPatchRequest 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
DatacentersNetworkloadbalancersFlowlogsPost
Create a NLB 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.
networkLoadBalancerId
string
The unique ID of the Network Load Balancer.
Other Parameters
Other parameters are passed through a pointer to an apiDatacentersNetworkloadbalancersFlowlogsPostRequest 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
DatacentersNetworkloadbalancersFlowlogsPut
Modify NLB 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.
networkLoadBalancerId
string
The unique ID of the Network Load Balancer.
flowLogId
string
The unique ID of the Flow Log.
Other Parameters
Other parameters are passed through a pointer to an apiDatacentersNetworkloadbalancersFlowlogsPutRequest 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
DatacentersNetworkloadbalancersForwardingrulesDelete
Delete NLB forwarding rules
Example
Path Parameters
ctx
context.Context
context for authentication, logging, cancellation, deadlines, tracing, etc.
datacenterId
string
The unique ID of the data center.
networkLoadBalancerId
string
The unique ID of the Network Load Balancer.
forwardingRuleId
string
The unique ID of the forwarding rule.
Other Parameters
Other parameters are passed through a pointer to an apiDatacentersNetworkloadbalancersForwardingrulesDeleteRequest 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
DatacentersNetworkloadbalancersForwardingrulesFindByForwardingRuleId
Retrieve NLB forwarding rules
Example
Path Parameters
ctx
context.Context
context for authentication, logging, cancellation, deadlines, tracing, etc.
datacenterId
string
The unique ID of the data center.
networkLoadBalancerId
string
The unique ID of the Network Load Balancer.
forwardingRuleId
string
The unique ID of the forwarding rule.
Other Parameters
Other parameters are passed through a pointer to an apiDatacentersNetworkloadbalancersForwardingrulesFindByForwardingRuleIdRequest 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
NetworkLoadBalancerForwardingRule
HTTP request headers
Content-Type: Not defined
Accept: application/json
DatacentersNetworkloadbalancersForwardingrulesGet
List NLB forwarding rules
Example
Path Parameters
ctx
context.Context
context for authentication, logging, cancellation, deadlines, tracing, etc.
datacenterId
string
The unique ID of the data center.
networkLoadBalancerId
string
The unique ID of the Network Load Balancer.
Other Parameters
Other parameters are passed through a pointer to an apiDatacentersNetworkloadbalancersForwardingrulesGetRequest 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
NetworkLoadBalancerForwardingRules
HTTP request headers
Content-Type: Not defined
Accept: application/json
DatacentersNetworkloadbalancersForwardingrulesPatch
Partially modify NLB forwarding rules
Example
Path Parameters
ctx
context.Context
context for authentication, logging, cancellation, deadlines, tracing, etc.
datacenterId
string
The unique ID of the data center.
networkLoadBalancerId
string
The unique ID of the Network Load Balancer.
forwardingRuleId
string
The unique ID of the forwarding rule.
Other Parameters
Other parameters are passed through a pointer to an apiDatacentersNetworkloadbalancersForwardingrulesPatchRequest struct via the builder pattern
networkLoadBalancerForwardingRuleProperties
The properties of the forwarding 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
NetworkLoadBalancerForwardingRule
HTTP request headers
Content-Type: Not defined
Accept: application/json
DatacentersNetworkloadbalancersForwardingrulesPost
Create a NLB Forwarding Rule
Example
Path Parameters
ctx
context.Context
context for authentication, logging, cancellation, deadlines, tracing, etc.
datacenterId
string
The unique ID of the data center.
networkLoadBalancerId
string
The unique ID of the Network Load Balancer.
Other Parameters
Other parameters are passed through a pointer to an apiDatacentersNetworkloadbalancersForwardingrulesPostRequest 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
NetworkLoadBalancerForwardingRule
HTTP request headers
Content-Type: application/json
Accept: application/json
DatacentersNetworkloadbalancersForwardingrulesPut
Modify NLB forwarding rules
Example
Path Parameters
ctx
context.Context
context for authentication, logging, cancellation, deadlines, tracing, etc.
datacenterId
string
The unique ID of the data center.
networkLoadBalancerId
string
The unique ID of the Network Load Balancer.
forwardingRuleId
string
The unique ID of the forwarding rule.
Other Parameters
Other parameters are passed through a pointer to an apiDatacentersNetworkloadbalancersForwardingrulesPutRequest struct via the builder pattern
networkLoadBalancerForwardingRule
The modified NLB forwarding rule.
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
NetworkLoadBalancerForwardingRule
HTTP request headers
Content-Type: application/json
Accept: application/json
DatacentersNetworkloadbalancersGet
List Network Load Balancers
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 apiDatacentersNetworkloadbalancersGetRequest 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.
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
DatacentersNetworkloadbalancersPatch
Partially modify Network Load Balancers
Example
Path Parameters
ctx
context.Context
context for authentication, logging, cancellation, deadlines, tracing, etc.
datacenterId
string
The unique ID of the data center.
networkLoadBalancerId
string
The unique ID of the Network Load Balancer.
Other Parameters
Other parameters are passed through a pointer to an apiDatacentersNetworkloadbalancersPatchRequest struct via the builder pattern
networkLoadBalancerProperties
The properties of the Network Load Balancer 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
DatacentersNetworkloadbalancersPost
Create a Network Load Balancer
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 apiDatacentersNetworkloadbalancersPostRequest 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
DatacentersNetworkloadbalancersPut
Modify Network Load Balancers
Example
Path Parameters
ctx
context.Context
context for authentication, logging, cancellation, deadlines, tracing, etc.
datacenterId
string
The unique ID of the data center.
networkLoadBalancerId
string
The unique ID of the Network Load Balancer.
Other Parameters
Other parameters are passed through a pointer to an apiDatacentersNetworkloadbalancersPutRequest 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
