NodeBalancers
NodeBalancer View
https://api.linode.com/v4/nodebalancers/{nodeBalancerId}Returns a single NodeBalancer you can access.
Path Parameters
The ID of the NodeBalancer to access.
Request Samples
- Shell
- CLI
curl -H "Authorization: Bearer $TOKEN" \
https://api.linode.com/v4/nodebalancers/12345
Response Samples
- 200
- default
{
"created": "2018-01-01T00:01:01.000Z",
"updated": "2018-03-01T00:01:01.000Z",
"id": 1234,
"label": "balancer12345",
"region": "us-east",
"tags": [],
"ipv4": "",
"ipv6": "",
"transfer": {
"total": 32.46078109741211,
"out": 3.5487728118896484,
"in": 28.91200828552246
},
"hostname": "192.0.2.1.ip.linodeusercontent.com",
"client_conn_throttle": ""
}Responses
200: The requested NodeBalancer object.
When this NodeBalancer was created.
When this NodeBalancer was last updated.
This NodeBalancer's unique ID.
This NodeBalancer's label. These must be unique on your Account.
The Region where this NodeBalancer is located. NodeBalancers only support backends in the same Region.
An array of Tags applied to this object. Tags are for organizational purposes only.
This NodeBalancer's public IPv4 address.
This NodeBalancer's public IPv6 address.
Information about the amount of transfer this NodeBalancer has had so far this month.
The total transfer, in MB, used by this NodeBalancer this month.
The total inbound transfer, in MB, used for this NodeBalancer this month.
The total outbound transfer, in MB, used for this NodeBalancer this month.
This NodeBalancer's hostname, beginning with its IP address and ending with .ip.linodeusercontent.com.
Throttle connections per second. Set to 0 (zero) to disable throttling.
default: Error
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.
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.
NodeBalancer Update
https://api.linode.com/v4/nodebalancers/{nodeBalancerId}Updates information about a NodeBalancer you can access.
Path Parameters
The ID of the NodeBalancer to access.
Request Body Schema
Throttle connections per second. Set to 0 (zero) to disable throttling.
This NodeBalancer's label. These must be unique on your Account.
An array of Tags applied to this object. Tags are for organizational purposes only.
Request Samples
- Shell
- CLI
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
- 200
- default
{
"id": 1234,
"label": "balancer12345",
"region": "us-east",
"created": "2018-01-01T00:01:01.000Z",
"updated": "2018-03-01T00:01:01.000Z",
"tags": [],
"ipv4": "",
"ipv6": "",
"hostname": "192.0.2.1.ip.linodeusercontent.com",
"client_conn_throttle": "",
"transfer": {
"total": 32.46078109741211,
"out": 3.5487728118896484,
"in": 28.91200828552246
}
}Responses
200: NodeBalancer updated successfully.
This NodeBalancer's unique ID.
This NodeBalancer's label. These must be unique on your Account.
An array of Tags applied to this object. Tags are for organizational purposes only.
When this NodeBalancer was created.
When this NodeBalancer was last updated.
The Region where this NodeBalancer is located. NodeBalancers only support backends in the same Region.
This NodeBalancer's public IPv4 address.
This NodeBalancer's public IPv6 address.
This NodeBalancer's hostname, beginning with its IP address and ending with .ip.linodeusercontent.com.
Throttle connections per second. Set to 0 (zero) to disable throttling.
Information about the amount of transfer this NodeBalancer has had so far this month.
The total transfer, in MB, used by this NodeBalancer this month.
The total inbound transfer, in MB, used for this NodeBalancer this month.
The total outbound transfer, in MB, used for this NodeBalancer this month.
default: Error
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.
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.
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.
Path Parameters
The ID of the NodeBalancer to access.
Request Samples
- Shell
- CLI
curl -H "Authorization: Bearer $TOKEN" \
-X DELETE \
https://api.linode.com/v4/nodebalancers/12345
Response Samples
- 200
- default
{}Responses
200: NodeBalancer deleted successfully.
default: Error
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.
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.