NodeBalancers

Rebuild Config

post
https://api.linode.com/v4/nodebalancers/{nodeBalancerId}/configs/{configId}/rebuild

Rebuilds a NodeBalancer Config and its Nodes that you have permission to modify.

Authorizations

Personal Access Token
OAuth: ( nodebalancers:read_write)

Path Parameters

nodeBalancerId
Required
integer

The ID of the NodeBalancer to access.

configId
Required
integer

The ID of the Config to access.

Request Body Schema

configs
array

Each config must have a unique port and at least one Node. Additionally: * Current Nodes excluded from the request body will be deleted.

  • Current Nodes (identified by their ID) will be updated.
  • New Nodes (included without an ID) will be created.

Request Samples

curl -H "Content-Type: application/json" \
    -H "Authorization: Bearer $TOKEN" \
    -X POST -d '{
      "port": 80,
      "protocol": "http",
      "algorithm": "roundrobin",
      "stickiness": "http_cookie",
      "check": "http_body",
      "check_interval": 90,
      "check_timeout": 10,
      "check_attempts": 3,
      "check_path": "/test",
      "check_body": "it works",
      "check_passive": true,
      "cipher_suite": "recommended",
      "nodes": [
        {
          "id": 543231,
          "address": "192.168.210.120:80",
          "label": "node54321",
          "weight": 50,
          "mode": "accept"
        },
        {
          "address": "192.168.210.122:81",
          "label": "thenewnode",
          "weight": 50,
          "mode": "accept"
        },
      ]
    }' \
    https://api.linode.com/v4/nodebalancers/12345/configs/4567/rebuild

Response Samples

{
  "id": 1234,
  "label": "balancer12345",
  "tags": [],
  "created": "2018-01-01T00:01:01.000Z",
  "region": "us-east",
  "updated": "2018-03-01T00:01:01.000Z",
  "ipv4": "",
  "ipv6": "",
  "hostname": "nb-207-192-68-16.newark.nodebalancer.linode.com",
  "client_conn_throttle": "",
  "transfer": [
    {
      "total": 32.46078109741211,
      "out": 3.5487728118896484,
      "in": 28.91200828552246
    }
  ]
}

Responses

200: NodeBalancer created successfully.

id
integer

This NodeBalancer's unique ID.

label
Filterable
string [3 .. 32] characters [a-zA-Z0-9-_]{3,32}

This NodeBalancer's label. These must be unique on your Account.

tags
Filterable
array of objects

An array of Tags applied to this object. Tags are for organizational purposes only.

created
string <date-time>

When this NodeBalancer was created.

region
Filterable
string

The Region where this NodeBalancer is located. NodeBalancers only support backends in the same Region.

updated
string <date-time>

When this NodeBalancer was last updated.

ipv4
string <ip>

This NodeBalancer's public IPv4 address.

ipv6
Nullable
string <ip>

This NodeBalancer's public IPv6 address.

hostname
string

This NodeBalancer's hostname, ending with .nodebalancer.linode.com

client_conn_throttle
integer

Throttle connections per second. Set to 0 (zero) to disable throttling.

transfer
object

Information about the amount of transfer this NodeBalancer has had so far this month.

total
Nullable
number

The total transfer, in MB, used by this NodeBalancer this month.

out
Nullable
number

The total inbound transfer, in MB, used for this NodeBalancer this month.

in
Nullable
number

The total outbound transfer, in MB, used for this NodeBalancer this month.

default: Error

errors
array of objects
reason
string

What happened to cause this error. In most cases, this can be fixed immediately by changing the data you sent in the request, but in some cases you will be instructed to open a Support Ticket or perform some other action before you can complete the request successfully.

field
string

The field in the request that caused this error. This may be a path, separated by periods in the case of nested fields. In some cases this may come back as "null" if the error is not specific to any single element of the request.