NodeBalancers

List NodeBalancers

get
https://api.linode.com/v4/nodebalancers

Returns a paginated list of NodeBalancers you have access to.

Authorizations

Personal Access Token
OAuth: ( nodebalancers:read_only)

Query Parameters

page
integer > = 1
Default: 1

The page of a collection to return.

page_size
integer [25 .. 100]
Default: 100

The number of items to return per page.

Request Samples

curl -H "Authorization: Bearer $TOKEN" \
    https://api.linode.com/v4/nodebalancers

Response Samples

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

Responses

200: A paginated list of NodeBalancers.

data
array of objects
id
integer

This NodeBalancer's unique ID.

created
string

When this NodeBalancer was created.

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

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

tags
Filterable
array

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

region
Filterable
string

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

updated
string

When this NodeBalancer was last updated.

ipv4
string

This NodeBalancer's public IPv4 address.

ipv6
Nullable
string

This NodeBalancer's public IPv6 address.

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.

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.

page
integer
pages
integer
results
integer

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.

Create NodeBalancer

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

Creates a NodeBalancer in the requested Region. This NodeBalancer will not start serving requests until it is configured.

Authorizations

Personal Access Token
OAuth: ( nodebalancers:read_write)

Request Body Schema

region
Required
string

The ID of the Region to create this NodeBalancer in.

client_conn_throttle
integer

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

configs
array

The ports to configure this NodeBalancer with on creation. Each config must have a unique port and at least one Node.

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

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

Request Samples

curl -H "Content-Type: application/json" \
    -H "Authorization: Bearer $TOKEN" \
    -X POST -d '{
      "region": "us-east",
      "label": "balancer12345",
      "client_conn_throttle": 0
    }' \
    https://api.linode.com/v4/nodebalancers

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.