Create a NLB Forwarding Rule

1 min

POST

https://api.ionos.com/cloudapi/v6/datacenters/{datacenterId}/networkloadbalancers/{networkLoadBalancerId}/forwardingrules

Creates a forwarding rule for the specified Network Load Balancer.

Path Parameters

datacenterIdstringrequired
Description
The unique ID of the data center.
networkLoadBalancerIdstringrequired
Description
The unique ID of the Network Load Balancer.

Query Parameters

prettyboolean
Description
Controls whether the response is pretty-printed (with indentations and new lines).
Default
true
depthinteger<int32>
Description
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
0
Format
int32
Minimum
0
Maximum
10

Header Parameters

X-Contract-Numberinteger<int32>
Description
Users with multiple contracts must provide the contract number, for which all API requests are to be executed.
Format
int32

Body Parameters

bodyNetworkLoadBalancerForwardingRulerequired
Description
The forwarding rule to create.
- typeobject
  - Type
- metadataDatacenterElementMetadata
  - etagstring
    Example
    45480eb3fbfc31f1d916c1eaa4abdcc3
    Description
    Resource's Entity Tag as defined in http://www.w3.org/Protocols/rfc2616/rfc2616-sec3.html#sec3.11 Entity Tag is also added as an 'ETag response header to requests which don't use 'depth' parameter.
  - createdDatestring<date-time>
    Example
    2015-12-04T14:34:09.809Z
    Description
    The last time the resource was created.
    Format
    date-time
  - createdBystring
    Example
    [email protected]
    Description
    The user who created the resource.
  - createdByUserIdstring
    Example
    [email protected]
    Description
    The unique ID of the user who created the resource.
  - lastModifiedDatestring<date-time>
    Example
    2015-12-04T14:34:09.809Z
    Description
    The last time the resource was modified.
    Format
    date-time
  - lastModifiedBystring
    Example
    [email protected]
    Description
    The user who last modified the resource.
  - lastModifiedByUserIdstring
    Example
    63cef532-26fe-4a64-a4e0-de7c8a506c90
    Description
    The unique ID of the user who last modified the resource.
  - statestring<AVAILABLE | INACTIVE | BUSY | DEPLOYING | ACTIVE | FAILED | SUSPENDED | FAILED_SUSPENDED | UPDATING | FAILED_UPDATING | DESTROYING | FAILED_DESTROYING | TERMINATED | HIBERNATING | FAILED_HIBERNATING | MAINTENANCE | FAILED_MAINTENANCE | UNKNOWN>
    Example
    AVAILABLE
    Description
    State of the resource. AVAILABLE There are no pending modification requests for this item; BUSY There is at least one modification request pending and all following requests will be queued; INACTIVE Resource has been de-provisioned; DEPLOYING Resource state DEPLOYING - relevant for Kubernetes cluster/nodepool; ACTIVE Resource state ACTIVE - relevant for Kubernetes cluster/nodepool; FAILED Resource state FAILED - relevant for Kubernetes cluster/nodepool; SUSPENDED Resource state SUSPENDED - relevant for Kubernetes cluster/nodepool; FAILED_SUSPENDED Resource state FAILED_SUSPENDED - relevant for Kubernetes cluster; UPDATING Resource state UPDATING - relevant for Kubernetes cluster/nodepool; FAILED_UPDATING Resource state FAILED_UPDATING - relevant for Kubernetes cluster/nodepool; DESTROYING Resource state DESTROYING - relevant for Kubernetes cluster; FAILED_DESTROYING Resource state FAILED_DESTROYING - relevant for Kubernetes cluster/nodepool; TERMINATED Resource state TERMINATED - relevant for Kubernetes cluster/nodepool; HIBERNATING Resource state HIBERNATING - relevant for Kubernetes cluster/nodepool; FAILED_HIBERNATING Resource state FAILED_HIBERNATING - relevant for Kubernetes cluster/nodepool; MAINTENANCE Resource state MAINTENANCE - relevant for Kubernetes cluster/nodepool; FAILED_HIBERNATING Resource state FAILED_HIBERNATING - relevant for Kubernetes cluster/nodepool.
    Allowed
    AVAILABLEINACTIVEBUSYDEPLOYINGACTIVEFAILEDSUSPENDEDFAILED_SUSPENDEDUPDATINGFAILED_UPDATINGDESTROYINGFAILED_DESTROYINGTERMINATEDHIBERNATINGFAILED_HIBERNATINGMAINTENANCEFAILED_MAINTENANCEUNKNOWN
- propertiesNetworkLoadBalancerForwardingRulePropertiesrequired
  - namestringrequired
    Example
    My Network Load Balancer forwarding rule
    Description
    The name of the Network Load Balancer forwarding rule.
  - algorithmstring<ROUND_ROBIN | LEAST_CONNECTION | RANDOM | SOURCE_IP>required
    Example
    ROUND_ROBIN
    Description
    Balancing algorithm
    Allowed
    ROUND_ROBINLEAST_CONNECTIONRANDOMSOURCE_IP
  - protocolstring<HTTP | TCP>required
    Example
    HTTP
    Description
    Balancing protocol
    Allowed
    HTTPTCP
  - listenerIpstringrequired
    Example
    81.173.1.2
    Description
    Listening (inbound) IP.
  - listenerPortinteger<int32>required
    Example
    8080
    Description
    Listening (inbound) port number; valid range is 1 to 65535.
    Format
    int32
  - healthCheckNetworkLoadBalancerForwardingRuleHealthCheck
    - clientTimeoutinteger<int32>
      Example
      50
      Description
      The maximum time in milliseconds to wait for the client to acknowledge or send data; default is 50,000 (50 seconds).
      Format
      int32
    - connectTimeoutinteger<int32>
      Example
      5000
      Description
      The maximum time in milliseconds to wait for a connection attempt to a target to succeed; default is 5000 (five seconds).
      Format
      int32
    - targetTimeoutinteger<int32>
      Example
      50000
      Description
      The maximum time in milliseconds that a target can remain inactive; default is 50,000 (50 seconds).
      Format
      int32
    - retriesinteger<int32>
      Example
      3
      Description
      The maximum number of attempts to reconnect to a target after a connection failure. Valid range is 0 to 65535 and default is three reconnection attempts.
      Format
      int32
  - targetsNetworkLoadBalancerForwardingRuleTarget[]required
    Description
    Array of items in the collection.
    - ipstringrequired
      Example
      22.231.2.2
      Description
      The IP of the balanced target VM.
    - portinteger<int32>required
      Example
      8080
      Description
      The port of the balanced target service; valid range is 1 to 65535.
      Format
      int32
    - weightinteger<int32>required
      Example
      123
      Description
      Traffic is distributed in proportion to target weight, relative to the combined weight of all targets. A target with higher weight receives a greater share of traffic. Valid range is 0 to 256 and default is 1. Targets with weight of 0 do not participate in load balancing but still accept persistent connections. It is best to assign weights in the middle of the range to leave room for later adjustments.
      Format
      int32
    - proxyProtocolstring<none | v1 | v2 | v2ssl>
      Example
      v1
      Description
      Proxy protocol version.
      Default
      none
      Allowed
      nonev1v2v2ssl
    - healthCheckNetworkLoadBalancerForwardingRuleTargetHealthCheck
      - checkboolean
        Description
        Makes the target available only if it accepts periodic health check TCP connection attempts; when turned off, the target is considered always available. The health check only consists of a connection attempt to the address and port of the target.
      - checkIntervalinteger<int32>
        Example
        2000
        Description
        The interval in milliseconds between consecutive health checks; default is 2000.
        Format
        int32
      - maintenanceboolean
        Description
        Maintenance mode prevents the target from receiving balanced traffic.

Responses

202Successful operation

NetworkLoadBalancerForwardingRule
- idstring
  Example
  15f67991-0f51-4efc-a8ad-ef1fb31a480c
  Description
  The resource's unique identifier.
- typeobject
  - Type
- hrefstring<uri>
  Example
  <RESOURCE-URI>
  Description
  URL to the object representation (absolute path).
  Format
  uri
- metadataDatacenterElementMetadata
  - etagstring
    Example
    45480eb3fbfc31f1d916c1eaa4abdcc3
    Description
    Resource's Entity Tag as defined in http://www.w3.org/Protocols/rfc2616/rfc2616-sec3.html#sec3.11 Entity Tag is also added as an 'ETag response header to requests which don't use 'depth' parameter.
  - createdDatestring<date-time>
    Example
    2015-12-04T14:34:09.809Z
    Description
    The last time the resource was created.
    Format
    date-time
  - createdBystring
    Example
    [email protected]
    Description
    The user who created the resource.
  - createdByUserIdstring
    Example
    [email protected]
    Description
    The unique ID of the user who created the resource.
  - lastModifiedDatestring<date-time>
    Example
    2015-12-04T14:34:09.809Z
    Description
    The last time the resource was modified.
    Format
    date-time
  - lastModifiedBystring
    Example
    [email protected]
    Description
    The user who last modified the resource.
  - lastModifiedByUserIdstring
    Example
    63cef532-26fe-4a64-a4e0-de7c8a506c90
    Description
    The unique ID of the user who last modified the resource.
  - statestring<AVAILABLE | INACTIVE | BUSY | DEPLOYING | ACTIVE | FAILED | SUSPENDED | FAILED_SUSPENDED | UPDATING | FAILED_UPDATING | DESTROYING | FAILED_DESTROYING | TERMINATED | HIBERNATING | FAILED_HIBERNATING | MAINTENANCE | FAILED_MAINTENANCE | UNKNOWN>
    Example
    AVAILABLE
    Description
    State of the resource. AVAILABLE There are no pending modification requests for this item; BUSY There is at least one modification request pending and all following requests will be queued; INACTIVE Resource has been de-provisioned; DEPLOYING Resource state DEPLOYING - relevant for Kubernetes cluster/nodepool; ACTIVE Resource state ACTIVE - relevant for Kubernetes cluster/nodepool; FAILED Resource state FAILED - relevant for Kubernetes cluster/nodepool; SUSPENDED Resource state SUSPENDED - relevant for Kubernetes cluster/nodepool; FAILED_SUSPENDED Resource state FAILED_SUSPENDED - relevant for Kubernetes cluster; UPDATING Resource state UPDATING - relevant for Kubernetes cluster/nodepool; FAILED_UPDATING Resource state FAILED_UPDATING - relevant for Kubernetes cluster/nodepool; DESTROYING Resource state DESTROYING - relevant for Kubernetes cluster; FAILED_DESTROYING Resource state FAILED_DESTROYING - relevant for Kubernetes cluster/nodepool; TERMINATED Resource state TERMINATED - relevant for Kubernetes cluster/nodepool; HIBERNATING Resource state HIBERNATING - relevant for Kubernetes cluster/nodepool; FAILED_HIBERNATING Resource state FAILED_HIBERNATING - relevant for Kubernetes cluster/nodepool; MAINTENANCE Resource state MAINTENANCE - relevant for Kubernetes cluster/nodepool; FAILED_HIBERNATING Resource state FAILED_HIBERNATING - relevant for Kubernetes cluster/nodepool.
    Allowed
    AVAILABLEINACTIVEBUSYDEPLOYINGACTIVEFAILEDSUSPENDEDFAILED_SUSPENDEDUPDATINGFAILED_UPDATINGDESTROYINGFAILED_DESTROYINGTERMINATEDHIBERNATINGFAILED_HIBERNATINGMAINTENANCEFAILED_MAINTENANCEUNKNOWN
- propertiesNetworkLoadBalancerForwardingRulePropertiesrequired
  - namestringrequired
    Example
    My Network Load Balancer forwarding rule
    Description
    The name of the Network Load Balancer forwarding rule.
  - algorithmstring<ROUND_ROBIN | LEAST_CONNECTION | RANDOM | SOURCE_IP>required
    Example
    ROUND_ROBIN
    Description
    Balancing algorithm
    Allowed
    ROUND_ROBINLEAST_CONNECTIONRANDOMSOURCE_IP
  - protocolstring<HTTP | TCP>required
    Example
    HTTP
    Description
    Balancing protocol
    Allowed
    HTTPTCP
  - listenerIpstringrequired
    Example
    81.173.1.2
    Description
    Listening (inbound) IP.
  - listenerPortinteger<int32>required
    Example
    8080
    Description
    Listening (inbound) port number; valid range is 1 to 65535.
    Format
    int32
  - healthCheckNetworkLoadBalancerForwardingRuleHealthCheck
    - clientTimeoutinteger<int32>
      Example
      50
      Description
      The maximum time in milliseconds to wait for the client to acknowledge or send data; default is 50,000 (50 seconds).
      Format
      int32
    - connectTimeoutinteger<int32>
      Example
      5000
      Description
      The maximum time in milliseconds to wait for a connection attempt to a target to succeed; default is 5000 (five seconds).
      Format
      int32
    - targetTimeoutinteger<int32>
      Example
      50000
      Description
      The maximum time in milliseconds that a target can remain inactive; default is 50,000 (50 seconds).
      Format
      int32
    - retriesinteger<int32>
      Example
      3
      Description
      The maximum number of attempts to reconnect to a target after a connection failure. Valid range is 0 to 65535 and default is three reconnection attempts.
      Format
      int32
  - targetsNetworkLoadBalancerForwardingRuleTarget[]required
    Description
    Array of items in the collection.
    - ipstringrequired
      Example
      22.231.2.2
      Description
      The IP of the balanced target VM.
    - portinteger<int32>required
      Example
      8080
      Description
      The port of the balanced target service; valid range is 1 to 65535.
      Format
      int32
    - weightinteger<int32>required
      Example
      123
      Description
      Traffic is distributed in proportion to target weight, relative to the combined weight of all targets. A target with higher weight receives a greater share of traffic. Valid range is 0 to 256 and default is 1. Targets with weight of 0 do not participate in load balancing but still accept persistent connections. It is best to assign weights in the middle of the range to leave room for later adjustments.
      Format
      int32
    - proxyProtocolstring<none | v1 | v2 | v2ssl>
      Example
      v1
      Description
      Proxy protocol version.
      Default
      none
      Allowed
      nonev1v2v2ssl
    - healthCheckNetworkLoadBalancerForwardingRuleTargetHealthCheck
      - checkboolean
        Description
        Makes the target available only if it accepts periodic health check TCP connection attempts; when turned off, the target is considered always available. The health check only consists of a connection attempt to the address and port of the target.
      - checkIntervalinteger<int32>
        Example
        2000
        Description
        The interval in milliseconds between consecutive health checks; default is 2000.
        Format
        int32
      - maintenanceboolean
        Description
        Maintenance mode prevents the target from receiving balanced traffic.

Response Headers

X-RateLimit-Remaininginteger<int32>
Description
The number of requests that can still be made without triggering a failure response.
Format
int32
X-RateLimit-Limitinteger<int32>
Description
The average number of requests per minute allowed.
Format
int32
X-RateLimit-Burstinteger<int32>
Description
The maximum number of concurrent API requests allowed.
Format
int32
Locationstring
Description
Callback URL to poll async operation status.
Pattern
https://[apiBaseUri]/requests/[requestId]/status

default

Any erroneous status code: 400 (parse error), 401 (auth error), 402 (trial access), 403 (insufficient privileges), 404 (not found), 405 (unsupported HTTP method), 415 (unsupported content type, 422 (validation error), 429 (request rate limit exceeded), 500 (server error), or 503 (maintenance).

Error
- httpStatusinteger<int32>
  Example
  400
  Description
  HTTP status code of the operation.
  Format
  int32
- messagesErrorMessage[]
  - errorCodestring
    Example
    123
    Description
    Application internal error code.
  - messagestring
    Example
    Error message example.
    Description
    A human-readable message.

curl

curl --request POST \
     --url 'https://api.ionos.com/cloudapi/v6/datacenters/{datacenterId}/networkloadbalancers/{networkLoadBalancerId}/forwardingrules?pretty=true&depth=integer%3Cint32%3E' \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --data '{
     "type": {},
     "properties": {
     "name": "My Network Load Balancer forwarding rule",
     "algorithm": "ROUND_ROBIN",
     "protocol": "HTTP",
     "listenerIp": "81.173.1.2",
     "listenerPort": 8080,
     "targets": [
     {
     "ip": "22.231.2.2",
     "port": 8080,
     "weight": 123,
     "proxyProtocol": "none"
     }
     ]
     }
     }'

javascript

var myHeaders = new Headers();
myHeaders.append("accept", "application/json");
myHeaders.append("content-type", "application/json");

var raw = JSON.stringify({
   "type": {},
   "properties": {
      "name": "My Network Load Balancer forwarding rule",
      "algorithm": "ROUND_ROBIN",
      "protocol": "HTTP",
      "listenerIp": "81.173.1.2",
      "listenerPort": 8080,
      "targets": [
         {
            "ip": "22.231.2.2",
            "port": 8080,
            "weight": 123,
            "proxyProtocol": "none"
         }
      ]
   }
});

var requestOptions = {
   method: 'POST',
   headers: myHeaders,
   body: raw,
   redirect: 'follow'
};

fetch("https://api.ionos.com/cloudapi/v6/datacenters/{datacenterId}/networkloadbalancers/{networkLoadBalancerId}/forwardingrules?pretty=true&depth=integer<int32>", requestOptions)
   .then(response => response.text())
   .then(result => console.log(result))
   .catch(error => console.log('error', error));

ruby

require "uri"
require "json"
require "net/http"

url = URI("https://api.ionos.com/cloudapi/v6/datacenters/{datacenterId}/networkloadbalancers/{networkLoadBalancerId}/forwardingrules?pretty=true&depth=integer<int32>")

https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true

request = Net::HTTP::Post.new(url)
request["accept"] = "application/json"
request["content-type"] = "application/json"
request.body = JSON.dump({
   "type": {},
   "properties": {
      "name": "My Network Load Balancer forwarding rule",
      "algorithm": "ROUND_ROBIN",
      "protocol": "HTTP",
      "listenerIp": "81.173.1.2",
      "listenerPort": 8080,
      "targets": [
         {
            "ip": "22.231.2.2",
            "port": 8080,
            "weight": 123,
            "proxyProtocol": "none"
         }
      ]
   }
})

response = https.request(request)
puts response.read_body

python

import requests
import json

url = "https://api.ionos.com/cloudapi/v6/datacenters/{datacenterId}/networkloadbalancers/{networkLoadBalancerId}/forwardingrules?pretty=true&depth=integer<int32>"

payload = json.dumps({
   "type": {},
   "properties": {
      "name": "My Network Load Balancer forwarding rule",
      "algorithm": "ROUND_ROBIN",
      "protocol": "HTTP",
      "listenerIp": "81.173.1.2",
      "listenerPort": 8080,
      "targets": [
         {
            "ip": "22.231.2.2",
            "port": 8080,
            "weight": 123,
            "proxyProtocol": "none"
         }
      ]
   }
})
headers = {
   'accept': 'application/json',
   'content-type': 'application/json'
}

response = requests.request("POST", url, headers=headers, data=payload)

print(response.text)

202

// Successful operation
{
  "id": "15f67991-0f51-4efc-a8ad-ef1fb31a480c",
  "type": {},
  "href": "<RESOURCE-URI>",
  "metadata": {
    "etag": "45480eb3fbfc31f1d916c1eaa4abdcc3",
    "createdDate": "2015-12-04T14:34:09.809Z",
    "createdBy": "[email protected]",
    "createdByUserId": "[email protected]",
    "lastModifiedDate": "2015-12-04T14:34:09.809Z",
    "lastModifiedBy": "[email protected]",
    "lastModifiedByUserId": "63cef532-26fe-4a64-a4e0-de7c8a506c90",
    "state": "AVAILABLE"
  },
  "properties": {
    "name": "My Network Load Balancer forwarding rule",
    "algorithm": "ROUND_ROBIN",
    "protocol": "HTTP",
    "listenerIp": "81.173.1.2",
    "listenerPort": 8080,
    "healthCheck": {
      "clientTimeout": 50,
      "connectTimeout": 5000,
      "targetTimeout": 50000,
      "retries": 3
    },
    "targets": [
      {
        "ip": "22.231.2.2",
        "port": 8080,
        "weight": 123,
        "proxyProtocol": "v1",
        "healthCheck": {
          "check": false,
          "checkInterval": 2000,
          "maintenance": false
        }
      }
    ]
  }
}

default

// Any erroneous status code: 400 (parse error), 401 (auth error), 402 (trial access), 403 (insufficient privileges), 404 (not found), 405 (unsupported HTTP method), 415 (unsupported content type, 422 (validation error), 429 (request rate limit exceeded), 500 (server error), or 503 (maintenance).
{
  "httpStatus": 400,
  "messages": [
    {
      "errorCode": "123",
      "message": "Error message example."
    }
  ]
}

Have a question?

Our super-smart AI, knowledgeable support team and an awesome community will get you an answer in a flash.

To ask a question or participate in discussions, you'll need to authenticate first.