NodeBalancers

View NodeBalancer

get
https://api.linode.com/v4/nodebalancers/{nodeBalancerId}

Returns a single NodeBalancer you can access.

Authorizations

Personal Access Token
OAuth: ( nodebalancers:read_only)

Path Parameters

nodeBalancerId
Required
integer

The ID of the NodeBalancer to access.

Request Samples

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

Response Samples

{
  "id": 1234,
  "created": "2018-01-01T00:01:01.000Z",
  "label": "balancer12345",
  "tags": [],
  "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": ""
}

Responses

200: The requested NodeBalancer object.

id
integer

This NodeBalancer's unique ID.

created
string <date-time>

When this NodeBalancer was created.

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.

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.

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.

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.

Update NodeBalancer

put
https://api.linode.com/v4/nodebalancers/{nodeBalancerId}

Updates information about a NodeBalancer you can access.

Authorizations

Personal Access Token
OAuth: ( nodebalancers:read_write)

Path Parameters

nodeBalancerId
Required
integer

The ID of the NodeBalancer to access.

Request Body Schema

client_conn_throttle
integer

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

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

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

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.

Request Samples

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

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 updated 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.

Delete NodeBalancer

delete
https://api.linode.com/v4/nodebalancers/{nodeBalancerId}

Deletes a NodeBalancer.

This is a destructive action and cannot be undone.

Deleting a NodeBalancer will also delete all associated Configs and Nodes, although the backend servers represented by the Nodes will not be changed or removed. Deleting a NodeBalancer will cause you to lose access to the IP Addresses assigned to this NodeBalancer.

Authorizations

Personal Access Token
OAuth: ( nodebalancers:read_write)

Path Parameters

nodeBalancerId
Required
integer

The ID of the NodeBalancer to access.

Request Samples

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

Response Samples

{}

Responses

200: NodeBalancer deleted successfully.

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.