--- updatedAt: 2026-06-08T17:25:49.000Z agentTools: siteIndex: https://techdocs.akamai.com/llms.txt projectIndex: https://techdocs.akamai.com/linode-api/llms.txt --- # List NodeBalancers Returns a paginated list of NodeBalancers you have access to. **Permissions and scopes** To call this operation, you need the following: - **Identity and access permissions**. Your user needs a role with these permissions assigned. [Learn more](https://techdocs.akamai.com/cloud-computing/docs/identity-access-cm-available-roles). - Permissions: `view_nodebalancer` - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `nodebalancers:read_only` **CLI** ```shell linode-cli nodebalancers list ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) # OpenAPI definition ````json { "components": { "securitySchemes": { "oauth": { "flows": { "authorizationCode": { "authorizationUrl": "https://login.linode.com/oauth/authorize", "scopes": { "account:read_only": "Allows access to GET information about your account.", "account:read_write": "Allows access to all endpoints related to your account.", "child_account:read_only": "Allows access to GET information about deprecated parent/child operations.", "child_account:read_write": "Allows access to deprecated parent/child operations.", "databases:read_only": "Allows access to GET information about databases.", "databases:read_write": "Allows access to all endpoints related to databases.", "domains:read_only": "Allows access to GET Domains on your account.", "domains:read_write": "Allows access to all Domain endpoints.", "events:read_only": "Allows access to GET your Events.", "events:read_write": "Allows access to all endpoints related to your Events.", "firewall:read_only": "Allows access to GET information about your Firewalls.", "firewall:read_write": "Allows access to all Firewall endpoints.", "images:read_only": "Allows access to GET your Images.", "images:read_write": "Allows access to all endpoints related to your Images.", "ips:read_only": "Allows access to GET your ips.", "ips:read_write": "Allows access to all endpoints related to your ips.", "linodes:read_only": "Allows access to GET Linodes on your account.", "linodes:read_write": "Allow access to all endpoints related to your Linodes.", "lke:read_only": "Allows access to GET LKE Clusters on your account.", "lke:read_write": "Allows access to all endpoints related to LKE Clusters on your account.", "longview:read_only": "Allows access to GET your Longview Clients.", "longview:read_write": "Allows access to all endpoints related to your Longview Clients.", "monitor:read_only": "Allows access to Monitor (Akamai Cloud Pulse) data.", "monitor:read_write": "Allows access to GET Monitor (Akamai Cloud Pulse) data.", "nodebalancers:read_only": "Allows access to GET NodeBalancers on your account.", "nodebalancers:read_write": "Allows access to all NodeBalancer endpoints.", "object_storage:read_only": "Allows access to GET information related to your Object Storage.", "object_storage:read_write": "Allows access to all Object Storage endpoints.", "stackscripts:read_only": "Allows access to GET your StackScripts.", "stackscripts:read_write": "Allows access to all endpoints related to your StackScripts.", "volumes:read_only": "Allows access to GET your Volumes.", "volumes:read_write": "Allows access to all endpoints related to your Volumes.", "vpc:read_write": "Allows access to all endpoints related to VPC and Subnet creation, updating, and deletion." }, "tokenUrl": "https://login.linode.com/oauth/token" } }, "type": "oauth2" }, "personalAccessToken": { "scheme": "bearer", "type": "http" } } }, "externalDocs": { "description": "See documentation for Akamai's Linode API", "url": "https://techdocs.akamai.com/linode-api/reference" }, "info": { "description": "\"[Read the API documentation](https://techdocs.akamai.com/linode-api/reference/api).\"", "license": { "name": "Apache 2.0", "url": "https://www.apache.org/licenses/LICENSE-2.0.html" }, "title": "NodeBalancers", "version": "4.229.1" }, "openapi": "3.0.1", "paths": { "/{apiVersion}/nodebalancers": { "get": { "description": "Returns a paginated list of NodeBalancers you have access to.\n\n\n**Permissions and scopes**\n\nTo call this operation, you need the following:\n\n- **Identity and access permissions**. Your user needs a role with these permissions assigned. [Learn more](https://techdocs.akamai.com/cloud-computing/docs/identity-access-cm-available-roles).\n - Permissions: `view_nodebalancer`\n- **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth).\n\n - Scopes: `nodebalancers:read_only`\n\n\n**CLI**\n\n```shell\nlinode-cli nodebalancers list\n```\n\n[Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli)", "externalDocs": { "description": "See documentation for this operation in Akamai's Linode API", "url": "https://techdocs.akamai.com/linode-api/reference/get-node-balancers" }, "operationId": "get-node-balancers", "parameters": [ { "description": "The page of a collection to return.", "in": "query", "name": "page", "required": false, "schema": { "default": 1, "example": 6, "minimum": 1, "type": "integer" }, "x-akamai": { "file-path": "parameters/page-offset.yaml" } }, { "description": "The number of items to return per page.", "in": "query", "name": "page_size", "schema": { "default": 100, "example": 50, "maximum": 500, "minimum": 25, "type": "integer" }, "x-akamai": { "file-path": "parameters/page-size.yaml" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "data": { "items": { "additionalProperties": false, "description": "Linode's load balancing solution. Can handle multiple ports, SSL termination, and any number of backends. NodeBalancer ports are configured with NodeBalancer configs, and each config is given one or more NodeBalancer nodes that accepts traffic. The traffic should be routed to the NodeBalancer's IP address, for the NodeBalancer to handle routing individual requests to backends.", "properties": { "backend_connectivity": { "description": "__Read-only__ The `backend_connectivity` setting determines how a NodeBalancer communicates with its backend nodes. You can't change this setting after creating the NodeBalancer, and all backend nodes must use IP addressing supported by the selected `backend_connectivity` type.\n\nAvailable options:\n - `legacy`: For Basic (`common`) NodeBalancers connecting to non-VPC backend nodes over private IPv4 in the `192.168.255.0/24` range. Not available for Premium NodeBalancers. You can only add backend nodes with private IPv4 addresses.\n - `ipv6`: For Basic (`common`) and Premium (`premium`) NodeBalancers connecting to non-VPC backend nodes over public IPv6. You can only add backend nodes with public IPv6 addresses.\n - `vpc`: For Basic (`common`) and Premium (`premium`) NodeBalancers connecting to VPC backend nodes with public IPv6 (BETA) or IPv4. You can only add backend nodes with VPC addresses.\nDefault behavior:\n - Basic NodeBalancers (`common`): If no parameters are specified, `backend_connectivity` is `undefined`. If only backend nodes are specified, it is inferred from the nodes. If `vpcs` is specified, it is set to `vpc`.\n - Premium NodeBalancers (`premium`): If no parameters are specified, `backend_connectivity` is `ipv6`. If only backend nodes are specified, it is inferred from the nodes. If `vpcs` is specified, it is set to `vpc`.", "example": "legacy", "readOnly": true, "type": "string", "x-linode-cli-display": 10 }, "backend_ipv6_prefix": { "description": "__Read-only__ The backend ACL for this NodeBalancer that can be used for firewall rules on their backend Linodes, allowing traffic only from that NodeBalancer backend source range.", "example": "2600:3c22:1:20:0:3039::/96", "nullable": true, "readOnly": true, "type": "string", "x-linode-cli-display": 11 }, "client_conn_throttle": { "description": "Throttle TCP connections per second for TCP, HTTP, and HTTPS configurations. Set to `0` (zero) to disable throttling.", "example": 10, "maximum": 20, "minimum": 0, "type": "integer", "x-linode-cli-display": 9 }, "created": { "description": "__Read-only__ When this NodeBalancer was created.", "example": "2018-01-01T00:01:01", "readOnly": true, "type": "string" }, "hostname": { "description": "__Read-only__ This NodeBalancer's hostname, beginning with its IP address and ending with _.ip.linodeusercontent.com_.", "example": "192.0.2.141.ip.linodeusercontent.com", "readOnly": true, "type": "string", "x-linode-cli-display": 5 }, "id": { "description": "__Read-only__ This NodeBalancer's unique ID.", "example": 12345, "readOnly": true, "type": "integer", "x-linode-cli-display": 1 }, "ipv4": { "description": "__Filterable__, __Read-only__ This NodeBalancer's public IPv4 address.", "example": "192.0.2.141", "format": "ip", "readOnly": true, "type": "string", "x-akamai": { "labels": [ "Filterable" ] }, "x-linode-cli-display": 6, "x-linode-filterable": true }, "ipv6": { "description": "__Read-only__ This NodeBalancer's public IPv6 address.", "example": null, "format": "ip", "nullable": true, "readOnly": true, "type": "string", "x-linode-cli-display": 7 }, "label": { "description": "__Filterable__ This NodeBalancer's label. These must be unique on your Account.", "example": "balancer12345", "maxLength": 32, "minLength": 3, "pattern": "[a-zA-Z0-9-_]{3,32}", "type": "string", "x-akamai": { "labels": [ "Filterable" ] }, "x-linode-cli-display": 2, "x-linode-filterable": true }, "lke_cluster": { "additionalProperties": false, "description": "__Read-only__ This NodeBalancer's related LKE cluster, if any. The value is `null` if this NodeBalancer isn't related to an LKE cluster.", "nullable": true, "properties": { "id": { "description": "The ID of the related LKE cluster.", "example": 12345, "type": "integer" }, "label": { "description": "The label of the related LKE cluster.", "example": "lkecluster12345", "type": "string" }, "type": { "description": "__Read-only__ The type for LKE clusters.", "example": "lkecluster", "readOnly": true, "type": "string" }, "url": { "description": "The URL where you can access the related LKE cluster.", "example": "/v4/lke/clusters/12345", "type": "string" } }, "readOnly": true, "type": "object", "x-linode-cli-display": 8 }, "locks": { "description": "__Beta__, __Filterable__, __Read-only__ Indicates if this NodeBalancer is protected by a lock to prevent accidental deletion. If the NodeBalancer has a `cannot_delete` lock, it can't be deleted, but its configurations and backend nodes can. If the NodeBalancer has a `cannot_delete_with_subresources` lock, both the NodeBalancer and attached resources such as configurations and backend nodes can't be deleted. Only account administrators can remove locks using the [Delete a resource lock](https://techdocs.akamai.com/linode-api/reference/delete-resource-lock) operation.", "example": [ "cannot_delete" ], "items": { "enum": [ "cannot_delete_with_subresources", "cannot_delete" ], "type": "string" }, "nullable": true, "readOnly": true, "type": "array", "x-akamai": { "labels": [ "Filterable" ], "status": "BETA" }, "x-linode-cli-display": 12, "x-linode-filterable": true }, "region": { "description": "__Filterable__, __Read-only__ The Region where this NodeBalancer is located. NodeBalancers only support backends in the same Region.", "example": "us-east", "readOnly": true, "type": "string", "x-akamai": { "labels": [ "Filterable" ] }, "x-linode-cli-display": 3, "x-linode-filterable": true }, "tags": { "description": "__Filterable__ An array of Tags applied to this object. Tags are for organizational purposes only.", "example": [ "example tag", "another example" ], "items": { "type": "string" }, "type": "array", "x-akamai": { "labels": [ "Filterable" ] }, "x-linode-filterable": true }, "transfer": { "additionalProperties": false, "description": "__Read-only__ Information about the amount of transfer this NodeBalancer has had so far this month.", "properties": { "in": { "description": "__Read-only__ The total inbound transfer, in MB, used for this NodeBalancer this month.", "example": 28.91200828552246, "nullable": true, "readOnly": true, "type": "number" }, "out": { "description": "__Read-only__ The total outbound transfer, in MB, used for this NodeBalancer this month.", "example": 3.5487728118896484, "nullable": true, "readOnly": true, "type": "number" }, "total": { "description": "__Read-only__ The total transfer, in MB, used by this NodeBalancer this month.", "example": 32.46078109741211, "nullable": true, "readOnly": true, "type": "number" } }, "readOnly": true, "type": "object" }, "type": { "description": "__Read-only__ The type of NodeBalancer.", "enum": [ "common", "premium" ], "example": "common", "readOnly": true, "type": "string", "x-linode-cli-display": 4 }, "updated": { "description": "__Read-only__ When this NodeBalancer was last updated.", "example": "2018-03-01T00:01:01", "readOnly": true, "type": "string" } }, "title": "NodeBalancer", "type": "object", "x-akamai": { "file-path": "schemas/node-balancer.yaml" } }, "type": "array" }, "page": { "description": "__Read-only__ The current [page](https://techdocs.akamai.com/linode-api/reference/pagination).", "example": 1, "readOnly": true, "type": "integer" }, "pages": { "description": "__Read-only__ The total number of [pages](https://techdocs.akamai.com/linode-api/reference/pagination).", "example": 1, "readOnly": true, "type": "integer" }, "results": { "description": "__Read-only__ The total number of results.", "example": 1, "readOnly": true, "type": "integer" } }, "type": "object", "x-akamai": { "file-path": "schemas/added-get-node-balancers-200.yaml" } }, "x-example": { "x-ref": "../examples/get-node-balancers-200.json" } } }, "description": "A paginated list of NodeBalancers." }, "default": { "content": { "application/json": { "example": { "errors": [ { "reason": "Invalid JSON" } ] }, "schema": { "additionalProperties": false, "properties": { "errors": { "description": "Any warnings associated with a response.", "items": { "additionalProperties": false, "description": "An object for describing a single error that occurred during the processing of a request.", "properties": { "field": { "description": "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.", "example": "fieldname", "type": "string" }, "reason": { "description": "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](https://techdocs.akamai.com/linode-api/reference/post-ticket) or perform some other action before you can complete the request successfully.", "example": "fieldname must be a valid value", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/error-object.yaml" } }, "type": "array" } }, "type": "object" } } }, "description": "See [Errors](https://techdocs.akamai.com/linode-api/reference/errors) for the range of possible error response codes." } }, "security": [ { "personalAccessToken": [] }, { "oauth": [ "nodebalancers:read_only" ] } ], "summary": "List NodeBalancers", "tags": [ "NodeBalancers" ], "x-akamai": { "tabs": [ { "syntax": "linode-cli nodebalancers list", "title": "CLI", "url": "https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli" } ] }, "x-linode-cli-action": [ "list", "ls" ], "x-linode-grant": "read_only", "x-linode-iam": [ { "permissions": [ "view_nodebalancer" ] } ] }, "parameters": [ { "description": "__Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta.", "in": "path", "name": "apiVersion", "required": true, "schema": { "enum": [ "v4", "v4beta" ], "example": "v4", "type": "string" }, "x-akamai": { "file-path": "parameters/api-version-path.yaml" } } ], "x-akamai": { "file-path": "paths/node-balancers.yaml", "path-info": "/{apiVersion}/nodebalancers" }, "x-linode-cli-command": "nodebalancers" } }, "servers": [ { "url": "https://api.linode.com" } ], "tags": [ { "description": "NodeBalancers is Linode's load balancing service. Use the NodeBalancers endpoints to create and manage NodeBalancers. You can also create and maintain configurations; create and maintain nodes, and view statistics.", "name": "NodeBalancers" } ], "x-akamai": { "auth-type": "OAUTH", "file-path": "node-balancers.yaml" }, "x-readme": { "apply-tag-changes": true, "explorer-enabled": false, "samples-languages": [ "curl", "python", "node" ] } } ```` # Sibling pages * [Create a NodeBalancer](https://techdocs.akamai.com/linode-api/reference/post-node-balancer.md) * [Get a NodeBalancer](https://techdocs.akamai.com/linode-api/reference/get-node-balancer.md) * [Update a NodeBalancer](https://techdocs.akamai.com/linode-api/reference/put-node-balancer.md) * [Delete a NodeBalancer](https://techdocs.akamai.com/linode-api/reference/delete-node-balancer.md) * [Get a NodeBalancer's backend IPv6 prefix](https://techdocs.akamai.com/linode-api/reference/get-node-balancer-backend-acl.md)