Update a NodeBalancer

put

https://api.linode.com/{apiVersion}/nodebalancers/{nodeBalancerId}

Updates information about a NodeBalancer you can access.

🚧
You can configure UDP on the same NodeBalancer that also uses TCP, HTTP, or HTTPS, but only when managing it through the API. If UDP is configured and you make changes to the TCP, HTTP or HTTPS settings in Cloud Manager, the existing UDP configuration will be overwritten. This is because Cloud Manager doesn't currently support UDP.

Permissions and scopes

To call this operation, you need permissions, based on the model you're using:

Identity and access permissions. Your user needs a role with these permissions. Learn more.
- Permissions: update_nodebalancer
OAuth scopes. Your user needs these scopes assigned. Learn more.
- Scopes: nodebalancers:read_write

CLI

linode-cli nodebalancers update 12345 \
  --label balancer12345 \
  --client_conn_throttle 0

Learn more

Path Params

apiVersion

string

enum

required

Enum Call either the v4 URL, or v4beta for operations still in Beta.

Allowed:

nodeBalancerId

integer

required

The ID of the NodeBalancer.

Body Params

The information to update.

Linode's load balancing solution. Can handle multiple ports, SSL termination, and any number of backends. NodeBalancer ports are configured with NodeBalancer configs, and each config is given one or more NodeBalancer nodes that accepts traffic. The traffic should be routed to the NodeBalancer's IP address, for the NodeBalancer to handle routing individual requests to backends.

client_conn_throttle

integer

0 to 20

Throttle TCP connections per second for TCP, HTTP, and HTTPS configurations. Set to 0 (zero) to disable throttling.

label

string

length between 3 and 32

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

200NodeBalancer updated successfully.

defaultSee Errors for the range of possible error response codes.