View All Products
Compute
Storage
Databases
Networking
Developer Tools
Delivery
Security
Services
Industries
Pricing
Community
Engage With Us
Linode API 4.163.0

Endpoints

Linode Instances

Linode NodeBalancers View

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

Returns a list of NodeBalancers that are assigned to this Linode and readable by the requesting User.

Read permission to a NodeBalancer can be given to a User by accessing the User's Grants Update (PUT /account/users/{username}/grants) endpoint.

Path Parameters

linodeId
Required
integer

ID of the Linode to look up

Request Samples

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

Response Samples

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

Responses

200: Returns 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.

updated
string

When this NodeBalancer was last updated.

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.

ipv4
Filterable
string

This NodeBalancer's public IPv4 address.

ipv6
Nullable
string

This NodeBalancer's public IPv6 address.

hostname
string

This NodeBalancer's hostname, beginning with its IP address and ending with .ip.linodeusercontent.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.

page
integer

The current page.

pages
integer

The total number of pages.

results
integer

The total number of results.