API

Create a NodeBalancer

post
https://api.linode.com//nodebalancers

Creates a NodeBalancer in the requested Region. Only available in regions with "NodeBalancers" in their capabilities.

NodeBalancers require a port config with at least one backend node to start serving requests.

When using the Linode CLI to create a NodeBalancer, first create a NodeBalancer without any configs. Then, create configs and nodes for that NodeBalancer with the respective Create a config and Create a node operations.

After creating a NodeBalancer, account administrators can add a lock to prevent accidental NodeBalancer deletion by using the Create a resource lock operation.

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: create_nodebalancer

  • OAuth scopes. Your user needs these scopes assigned. Learn more.

    • Scopes: nodebalancers:read_write

CLI

linode-cli nodebalancers create \
  --region us-east \
  --label balancer12345 \
  --ipv4 "192.0.2.141" \
  --client_conn_throttle 0

Learn more

Path Params
string
enum
required

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

Allowed:
Body Params
integer
0 to 20

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

configs
array of objects

The port configs to create for this NodeBalancer. Each config needs a unique port and at least one node.

configs
integer

The ID of the Firewall to assign to the NodeBalancer.

  • A NodeBalancer can have only one Firewall assigned to it.
  • Firewalls control inbound network traffic to NodeBalancers.
string

To ensure your NodeBalancer maintains a consistent public address, you can specify an unassigned reserved IP from your account during creation. If this field is omitted, the NodeBalancer is assigned a standard ephemeral IP by default.

string
length between 3 and 32

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

string
required

The ID of the Region to create this NodeBalancer in.

tags
array of strings

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

tags
vpcs
array of objects

You can have only one vpcs in a NodeBalancer configuration. If any of your backend nodes are VPC Linodes, specify the VPC subnet and CIDR range. NodeBalancer routes traffic to backend VPC nodes through this subnet. The specified VPC subnet must exist within the same data center as the NodeBalancer, and the provided IP range must be contained within the subnet's CIDR block. All IP addresses within the specified range must be free and available for assignment. Once the NodeBalancer is created, its VPC cannot be changed.

vpcs
Responses

Updated about 1 month ago

Language
Credentials
LoadingLoading…
Response
Choose an example:
application/json

Updated about 1 month ago