API

Linode API v4
API summary
Get started
API workflows
API conventions
Command line interface (CLI)
Errors
- 299
- 400
- 401
- 403
- 404
- 405
- 406
- 415
- 429
- 500
- 504

Account

Account
Beta programs
Account agreements
- Acknowledge agreementspost
- List agreementsget
Account availability
- List available servicesget
Child accounts
Payments
Entity transfers
Events
Invoices
Logins
- List user loginsget
- Get an account loginget
Maintenances
- List maintenancesget
Notifications
- List notificationsget
OAuth clients
Client thumbnail
- Get the OAuth client's thumbnailget
- Update the OAuth client's thumbnailput
Payment methods
Promo credits
- Add a promo creditpost
Service transfers
Account settings
- Get account settingsget
- Update account settingsput
Settings
- Enable Linode Managedpost
Account transfer
- Get network usageget
Users

Beta programs

Beta programs
- List Beta programsget
- Get a Beta programget

Databases

Databases
Engines
- List Managed Databases enginesget
- Get a Managed Databases engineget
Advanced parameters
- List MySQL Managed Database advanced parametersget
- List PostgreSQL Managed Database advanced parametersget
Credentials
SSL certificates
- Get a MySQL Managed Database SSL certificateget
- Get a PostgreSQL Managed Database SSL certificateget
Types
- List Managed Databases typesget
- Get a Managed Databases typeget

Domains

Domains
Records
Domain zone file
- Get a domain zone fileget

Images

Images

Linode instances

Linode instances
Linode types
- List typesget
- Get a typeget
NodeBalancers
- List Linode NodeBalancersget
Volumes
- List a Linode's volumesget
Backups
Configurations
Interfaces
Disks
Firewalls
Linode interfaces
IP addresses
Statistics
- Get Linode statisticsget
- Get monthly statisticsget
Network transfers
- Get a network transferget
Network transfer statistics
- Get monthly network transfer statsget
Kernels
- List kernelsget
- Get a kernelget

Linode Kubernetes Engine (LKE)

Clusters
LKE API endpoints
- List Kubernetes API endpointsget
LKE Control Plane ACL
Cluster dashboard
- Get a Kubernetes cluster dashboard URLget
Kubeconfigs
- Get a Kubeconfigget
- Delete a Kubeconfigdelete
Nodes
Node pools
Service tokens
- Delete a service tokendelete
LKE versions
LKE types
- List Kubernetes typesget

Linode StackScripts

StackScripts

Longview

Clients
Plans
- Get a Longview planget
- Update a Longview planput
Subscriptions
- List Longview subscriptionsget
- Get a Longview subscriptionget
Longview types
- List Longview typesget

Managed

Contacts
Credentials
Managed SSH keys
- Get a managed SSH keyget
Issues
- List managed issuesget
- Get a managed issueget
Linode settings
- List managed Linode settingsget
Managed settings
- Get a Linode's managed settingsget
- Update a Linode's managed settingsput
Services
Statistics
- List managed statsget

Monitor

Metrics
Alerts

Network transfer prices

Network transfer prices
- List network transfer pricesget

Networking

Firewalls
Firewall settings
- List default firewallsget
- Update default firewallsput
Templates
- List firewall templatesget
- Get a firewall templateget
Devices
IP addresses
IPv4 addresses
- Assign IPv4s to Linodespost
- Configure IPv4 sharingpost
IPv6 pools
- List IPv6 poolsget
IPv6 ranges
VLANs
- List VLANsget
- Delete a VLANdelete

NodeBalancers

NodeBalancers
VPCs
- List VPC configurationsget
- Get a VPC configurationget
NodeBalancer types
- List NodeBalancer typesget
Configurations
Nodes
Firewalls
- List NodeBalancer firewallsget
- Update a NodeBalancer's firewallsput
Statistics
- Get NodeBalancer statisticsget

Object Storage

Object Storage
- Cancel Object Storagepost
- Get Object Storage transfer dataget
Buckets
Bucket access
ACL configurations
- Get an Object Storage object ACL configurationget
- Update an object's ACL configurationput
Bucket contents
- List Object Storage bucket contentsget
TLS/SSL certificates
Clusters
- List clustersget
- Get a clusterget
Endpoints
- List Object Storage endpointsget
Keys
Object Storage quotas
Object Storage types
- List Object Storage typesget

Placement groups

Placement groups

Profile

Profile
- Get a profileget
- Update a profileput
Apps
Devices
Grants
- List grantsget
Logins
- List loginsget
- Get a profile's loginget
Phone number
Preferences
- Get user preferencesget
- Update a user's preferencesput
Security questions
- Answer security questionspost
- List security questionsget
SSH keys
Two factor authentication
Personal access tokens

Regions

Regions

Support

Support tickets
Attachments
- Create a support ticket attachmentpost
Replies
- Create a replypost
- List repliesget

Volumes

Volumes
Volume types
- List volume typesget

VPCs

VPCs
IP addresses
- List VPC IP addressesget
- List a VPC's IP addressesget
VPC subnets

Update a NodeBalancer

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

Updates information about a NodeBalancer you can access.

🚧
You can configure UDP on the same NodeBalancer that also uses TCP, HTTP, or HTTPS, but only when managing it through the API. If UDP is configured and you make changes to the TCP, HTTP or HTTPS settings in Cloud Manager, the existing UDP configuration will be overwritten. This is because Cloud Manager doesn't currently support UDP.

linode-cli nodebalancers update 12345 \
  --label balancer12345 \
  --client_conn_throttle 0


Learn more...

nodebalancers:read_write


Learn more...

Path Params

apiVersion

string

required

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

nodeBalancerId

integer

required

The ID of the NodeBalancer.

Body Params

client_conn_throttle

integer

0 to 20

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

label

string

length between 3 and 32

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

tags

array of strings

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

tags

Responses

Response body

object

client_conn_throttle

integer

0 to 20

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

created

date-time

Read-only When this NodeBalancer was created.

hostname

string

Read-only This NodeBalancer's hostname, beginning with its IP address and ending with .ip.linodeusercontent.com.

integer

Read-only This NodeBalancer's unique ID.

ipv4

string

Filterable, Read-only This NodeBalancer's public IPv4 address.

ipv6

string | null

Read-only This NodeBalancer's public IPv6 address.

label

string

length between 3 and 32

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

lke_cluster

object | null

Read-only This NodeBalancer's related LKE cluster, if any. The value is null if this NodeBalancer isn't related to an LKE cluster.

string

The ID of the related LKE cluster.

label

string

The label of the related LKE cluster.

type

string

Read-only The type for LKE clusters.

url

string

The URL where you can access the related LKE cluster.

region

string

Filterable, Read-only The Region where this NodeBalancer is located. NodeBalancers only support backends in the same Region.

tags

array of strings

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

tags

transfer

object

Read-only Information about the amount of transfer this NodeBalancer has had so far this month.

number | null

Read-only The total outbound transfer, in MB, used for this NodeBalancer this month.

out

number | null

Read-only The total inbound transfer, in MB, used for this NodeBalancer this month.

total

number | null

Read-only The total transfer, in MB, used by this NodeBalancer this month.

type

string

Read-only The type of NodeBalancer.

common premium

updated

date-time

Read-only When this NodeBalancer was last updated.

Response body

object

errors

array of objects

errors

object

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.

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.

Updated 20 days ago

Get a NodeBalancer

Delete a NodeBalancer

Language

Credentials


xxxxxxxxxx
1
curl --request PUT \
2
     --url https://api.linode.com/v4/nodebalancers/nodeBalancerId \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

Updated 20 days ago

Get a NodeBalancer

Delete a NodeBalancer

API
Linode API v4
API summary
Get started
API workflows
API conventions
Response headers
Time values
Filtering and sorting
Pagination
Rate limits
Command line interface (CLI)
Errors
504
500
429
415
406
405
404
403
401
400
299

Account
Account
Delete your accountpost
Get a region's service availabilityget
Update your accountput
Get your accountget
Beta programs
Get an enrolled Beta programget
List enrolled Beta programsget
Enroll in a Beta programpost
Account agreements
List agreementsget
Acknowledge agreementspost
Account availability
List available servicesget
Child accounts
Create a proxy user tokenpost
Get a child accountget
List child accountsget
Payments
Get a paymentget
Execute a PayPal paymentpost
Stage a PayPal paymentpost
List paymentsget
Make a paymentpost
Add or edit a credit cardpost
Entity transfers
Accept an entity transferpost
Cancel an entity transferdelete
Get an entity transferget
List entity transfersget
Create an entity transferpost
Events
Mark an event as seenpost
Get an eventget
List eventsget
Invoices
List invoice itemsget
Get an invoiceget
List invoicesget
Logins
Get an account loginget
List user loginsget
Maintenances
List maintenancesget
Notifications
List notificationsget
OAuth clients
Reset an OAuth client secretpost
Delete an OAuth clientdelete
Update an OAuth clientput
Get an OAuth clientget
List OAuth clientsget
Create an OAuth clientpost
Client thumbnail
Update the OAuth client's thumbnailput
Get the OAuth client's thumbnailget
Payment methods
Set a default payment methodpost
Delete a payment methoddelete
Get a payment methodget
List payment methodsget
Add a payment methodpost
Promo credits
Add a promo creditpost
Service transfers
Accept a service transferpost
Cancel a service transferdelete
Get a service transfer requestget
List service transfersget
Request a service transferpost
Account settings
Update account settingsput
Get account settingsget
Settings
Enable Linode Managedpost
Account transfer
Get network usageget
Users
Update a user's grantsput
List a user's grantsget
Delete a userdelete
Update a userput
Get a userget
List usersget
Create a userpost

Beta programs
Beta programs
Get a Beta programget
List Beta programsget

Databases
Databases
Suspend a PostgreSQL Managed Databasepost
Resume a PostgreSQL Managed Databasepost
Patch a PostgreSQL Managed Databasepost
Delete a PostgreSQL Managed Databasedelete
Update a PostgreSQL Managed Databaseput
Get a PostgreSQL Managed Databaseget
List PostgreSQL Managed Databasesget
Create or restore a PostgreSQL Managed Databasepost
Suspend a MySQL Managed Databasepost
Resume a MySQL Managed Databasepost
Patch a MySQL Managed Databasepost
Delete a MySQL Managed Databasedelete
Update a MySQL Managed Databaseput
Get a MySQL Managed Databaseget
List MySQL Managed Databasesget
Create or restore a MySQL Managed Databasepost
List Managed Databasesget
Engines
Get a Managed Databases engineget
List Managed Databases enginesget
Advanced parameters
List PostgreSQL Managed Database advanced parametersget
List MySQL Managed Database advanced parametersget
Credentials
Reset PostgreSQL Managed Database credentialspost
Get PostgreSQL Managed Database credentialsget
Reset MySQL Managed Database credentialspost
Get MySQL Managed Database credentialsget
SSL certificates
Get a PostgreSQL Managed Database SSL certificateget
Get a MySQL Managed Database SSL certificateget
Types
Get a Managed Databases typeget
List Managed Databases typesget

Domains
Domains
Clone a domainpost
Delete a domaindelete
Update a domainput
Get a domainget
Import a domainpost
List domainsget
Create a domainpost
Records
Delete a domain recorddelete
Update a domain recordput
Get a domain recordget
List domain recordsget
Create a domain recordpost
Domain zone file
Get a domain zone fileget

Images
Images
Replicate an imagepost
Delete an imagedelete
Update an imageput
Get an imageget
Upload an imagepost
List imagesget
Create an imagepost

Linode instances
Linode instances
Shut down a Linodepost
Resize a Linodepost
Boot a Linode into rescue modepost
Rebuild a Linodepost
Reboot a Linodepost
Reset a Linode's root passwordpost
Upgrade a Linodepost
Launch a DC migration/pending host migrationpost
Clone a Linodepost
Boot a Linodepost
Delete a Linodedelete
Update a Linodeput
Get a Linodeget
List Linodesget
Create a Linodepost
Linode types
Get a typeget
List typesget
NodeBalancers
List Linode NodeBalancersget
Volumes
List a Linode's volumesget
Backups
Restore a backuppost
Get a backupget
Enable backupspost
Cancel backupspost
List backupsget
Create a snapshotpost
Configurations
Delete a configuration profiledelete
Update a configuration profileput
Get a configuration profileget
List configuration profilesget
Create a configuration profilepost
Interfaces
Delete a configuration profile interfacedelete
Update a configuration profile interfaceput
Get a configuration profile interfaceget
Reorder configuration profile interfacespost
List configuration profile interfacesget
Add a configuration profile interfacepost
Disks
Resize a diskpost
Reset a disk root passwordpost
Clone a diskpost
Delete a diskdelete
Update a diskput
Get a diskget
List disksget
Create a diskpost
Firewalls
Apply a Linode's firewallspost
Update a Linode's firewallsput
List a Linode's firewallsget
Linode interfaces
Upgrade to Linode interfacespost
List Linode interface firewallsget
Delete a Linode interfacedelete
Update a Linode interfaceput
Get a Linode interfaceget
Update Linode interface settingsput
List Linode interface settingsget
List Linode interfacesget
Add a Linode interfacepost
IP addresses
Delete an IPv4 addressdelete
Update an IP address's RDNS for a Linodeput
Get a Linode's IP addressget
Get networking informationget
Allocate an IPv4 addresspost
Statistics
Get monthly statisticsget
Get Linode statisticsget
Network transfers
Get a network transferget
Network transfer statistics
Get monthly network transfer statsget
Kernels
Get a kernelget
List kernelsget

Linode Kubernetes Engine (LKE)
Clusters
Regenerate a Kubernetes clusterpost
Recycle cluster nodespost
Delete a Kubernetes clusterdelete
Update a Kubernetes clusterput
Get a Kubernetes clusterget
List Kubernetes clustersget
Create a Kubernetes clusterpost
LKE API endpoints
List Kubernetes API endpointsget
LKE Control Plane ACL
Delete the control plane access control listdelete
Update the control plane access control listput
Get the control plane access control listget
Cluster dashboard
Get a Kubernetes cluster dashboard URLget
Kubeconfigs
Delete a Kubeconfigdelete
Get a Kubeconfigget
Nodes
Recycle a nodepost
Delete a nodedelete
Get a nodeget
Node pools
Recycle a node poolpost
Delete a node pooldelete
Update a node poolput
Get a node poolget
List node poolsget
Create a node poolpost
Service tokens
Delete a service tokendelete
LKE versions
Get an LKE Kubernetes version (non-enterprise)get
List LKE Kubernetes versions (non-enterprise)get
Get an LKE Kubernetes version (any tier)get
List LKE Kubernetes versions (any tier)get
LKE types
List Kubernetes typesget

Linode StackScripts
StackScripts
Delete a StackScriptdelete
Update a StackScriptput
Get a StackScriptget
List StackScriptsget
Create a StackScriptpost

Longview
Clients
Delete a Longview clientdelete
Update a Longview clientput
Get a Longview clientget
List Longview clientsget
Create a Longview clientpost
Plans
Update a Longview planput
Get a Longview planget
Subscriptions
Get a Longview subscriptionget
List Longview subscriptionsget
Longview types
List Longview typesget

Managed
Contacts
Delete a managed contactdelete
Update a managed contactput
Get a managed contactget
List managed contactsget
Create a managed contactpost
Credentials
Update a managed credential's username and passwordpost
Delete a managed credentialpost
Update a managed credentialput
Get a managed credentialget
List managed credentialsget
Create a managed credentialpost
Managed SSH keys
Get a managed SSH keyget
Issues
Get a managed issueget
List managed issuesget
Linode settings
List managed Linode settingsget
Managed settings
Update a Linode's managed settingsput
Get a Linode's managed settingsget
Services
Enable a managed servicepost
Disable a managed servicepost
Delete a managed servicedelete
Update a managed serviceput
Get a managed serviceget
List managed servicesget
Create a managed servicepost
Statistics
List managed statsget

Monitor
Metrics
Get an entity's metricspost
Create a token for a service typepost
List metrics for a service typeget
List dashboards for a service typeget
Get details for a supported service typeget
List supported service typesget
Get a dashboardget
List dashboardsget
Alerts
List alert channelsget
Delete an alert definitiondelete
Update an alert definitionput
List alert definitions for a service typeget
Get an alert definitionget
List alert definitionsget
Create an alert definitionpost

Network transfer prices
Network transfer prices
List network transfer pricesget

Networking
Firewalls
Update firewall rulesput
List firewall rulesget
Get a firewall rule versionget
List firewall rule versionsget
Delete a firewalldelete
Update a firewallput
Get a firewallget
List firewallsget
Create a firewallpost
Firewall settings
Update default firewallsput
List default firewallsget
Templates
Get a firewall templateget
List firewall templatesget
Devices
Delete a firewall devicedelete
Get a firewall deviceget
List firewall devicesget
Create a firewall devicepost
IP addresses
Update an IP address's RDNSput
Get an IP addressget
Share IP addressespost
Assign IP addressespost
List IP addressesget
Allocate an IP addresspost
IPv4 addresses
Configure IPv4 sharingpost
Assign IPv4s to Linodespost
IPv6 pools
List IPv6 poolsget
IPv6 ranges
Delete an IPv6 rangedelete
Get an IPv6 rangeget
List IPv6 rangesget
Create an IPv6 rangepost
VLANs
Delete a VLANdelete
List VLANsget

NodeBalancers
NodeBalancers
Delete a NodeBalancerdelete
Update a NodeBalancerput
Get a NodeBalancerget
List NodeBalancersget
Create a NodeBalancerpost
VPCs
Get a VPC configurationget
List VPC configurationsget
NodeBalancer types
List NodeBalancer typesget
Configurations
Rebuild a configpost
Delete a configdelete
Update a configput
Get a configget
List configsget
Create a configpost
Nodes
Delete a NodeBalancer's nodedelete
Update a nodeput
Get a NodeBalancer's nodeget
List nodesget
Create a nodepost
Firewalls
Update a NodeBalancer's firewallsput
List NodeBalancer firewallsget
Statistics
Get NodeBalancer statisticsget

Object Storage
Object Storage
Get Object Storage transfer dataget
Cancel Object Storagepost
Buckets
Create a URL for an objectpost
Remove an Object Storage bucketdelete
Get an Object Storage bucketget
List Object Storage buckets per regionget
List Object Storage bucketsget
Create an Object Storage bucketpost
Bucket access
Update access to an Object Storage bucketput
Get Object Storage bucket accessget
Allow access to an Object Storage bucketpost
ACL configurations
Update an object's ACL configurationput
Get an Object Storage object ACL configurationget
Bucket contents
List Object Storage bucket contentsget
TLS/SSL certificates
Delete an Object Storage TLS/SSL certificatedelete
Get an Object Storage TLS/SSL certificateget
Upload an Object Storage TLS/SSL certificatepost
Clusters
Get a clusterget
List clustersget
Endpoints
List Object Storage endpointsget
Keys
Revoke an Object Storage keydelete
Update an Object Storage keyput
Get an Object Storage keyget
List Object Storage keysget
Create an Object Storage keypost
Object Storage quotas
Get Object Storage quota usage dataget
Get an Object Storage quotaget
List Object Storage quotasget
Object Storage types
List Object Storage typesget

Placement groups
Placement groups
Unassign a placement grouppost
Assign a placement grouppost
Delete a placement groupdelete
Update a placement groupput
Get a placement groupget
List placement groupsget
Create placement grouppost

Profile
Profile
Update a profileput
Get a profileget
Apps
Revoke app accessdelete
Get an authorized appget
List authorized appsget
Devices
Revoke a trusted devicedelete
Get a trusted deviceget
List trusted devicesget
Grants
List grantsget
Logins
Get a profile's loginget
List loginsget
Phone number
Verify a phone numberpost
Delete a phone numberdelete
Send a phone number verification codepost
Preferences
Update a user's preferencesput
Get user preferencesget
Security questions
List security questionsget
Answer security questionspost
SSH keys
Delete an SSH keydelete
Update an SSH keyput
Get an SSH keyget
List SSH keysget
Add an SSH keypost
Two factor authentication
Enable two factor authenticationpost
Create a two factor secretpost
Disable two factor authenticationpost
Personal access tokens
Revoke a personal access tokendelete
Update a personal access tokenput
Get a personal access tokenget
List personal access tokensget
Create a personal access tokenpost

Regions
Regions
Get a region's availabilityget
Get a regionget
List regions' availabilityget
List regionsget

Support
Support tickets
Close a support ticketpost
Get a support ticketget
List support ticketsget
Open a support ticketpost
Attachments
Create a support ticket attachmentpost
Replies
List repliesget
Create a replypost

Tags
Tags
Delete a tagdelete
List tagged objectsget
List tagsget
Create a tagpost

Volumes
Volumes
Resize a volumepost
Detach a volumepost
Clone a volumepost
Attach a volumepost
Delete a volumedelete
Update a volumeput
Get a volumeget
List volumesget
Create a volumepost
Volume types
List volume typesget

VPCs
VPCs
Delete a VPCdelete
Update a VPCput
Get a VPCget
List VPCsget
Create a VPCpost
IP addresses
List a VPC's IP addressesget
List VPC IP addressesget
VPC subnets
Delete a VPC subnetdelete
Update a VPC subnetput
Get a VPC subnetget
List VPC subnetsget
Create a VPC subnetpost

200NodeBalancer updated successfully.

defaultSee Errors for the range of possible error response codes.