List Load Balancers

GET

/api/v1/appliances/

curl --request GET \
  --url 'https://api.e2enetworks.com/myaccount/api/v1/appliances/?project_id=<PROJECT_ID>&apikey=<API_KEY>&location=<LOCATION>' \
  --header 'Authorization: Bearer <API_TOKEN>'

Returns a paginated list of the load balancer appliances in the project. Each entry contains the underlying node detail (public/private IP, plan, price), the full HAProxy configuration context (the same object you send to Update Load Balancer), the current status, and committed-pricing details. Use page_no and per_page to page through results; total_count and total_page_number are returned at the top level.

Parameters

Query Parameters

page_no

integer

1-based page number to retrieve.

Example

1

per_page

integer

Number of load balancers to return per page.

Example

5

advance_search_string

boolean

Reserved search flag used by the console. Send false for the standard listing.

Example

false

project_id

required

integer

Identifier of the project to scope the request to. Required integer project ID.

Example

<PROJECT_ID>

apikey

required

string

API key used to authenticate the request

Example

<API_KEY>

location

required

string

Region to filter load balancers by.

Example

<LOCATION>

Responses

200

Successful response

Media typeapplication/json

object

code

integer

data

Array<object>

object

id

Load balancer (appliance) ID.

integer

name

string

customer

integer

status

Lifecycle state (e.g. Creating, Running, Powered off).

string

node_detail

The underlying VM backing the appliance.

object

node_id

integer

vm_id

VM ID - used as the vm_id path parameter for BitNinja actions.

integer

private_ip

string

public_ip

string

ram

string

disk

string

vcpu

integer

billing_type

string

price

string

plan_name

string

appliance_instance

The HAProxy instance(s). context is the full configuration object - the same shape you PUT to Update Load Balancer.

Array<object>

object

id

string

run

string

nullable

context

Full load balancer configuration. See the Update Load Balancer request body for the field reference.

object

lb_name

string

lb_type

string

lb_mode

string

lb_port

string

plan_name

string

node_list_type

string

backends

Array

tcp_backend

Array

acl_list

Array

acl_map

Array

enable_bitninja

boolean

security_group_id

integer

host_target

string

management_ip

string

created_at

string

updated_at

string

eos_enabled_status

Whether access-log shipping (EOS) is enabled.

boolean

project_name

string

isEncryptionEnabled

boolean

errors

object

message

string

total_page_number

integer

total_count

integer

Example

{
  "code": 200,
  "data": [
    {
      "id": 7975,
      "name": "LB-NLB-26321-4626",
      "customer": 33935,
      "status": "Creating",
      "node_detail": {
        "node_id": 316770,
        "vm_id": 320926,
        "private_ip": "10.8.46.6",
        "public_ip": "164.52.192.224",
        "ram": "6 GB",
        "disk": "10 GB",
        "vcpu": 4,
        "billing_type": "hourly",
        "price": "Rs. 2.0/Hour or Rs. 1460.0 Monthly",
        "plan_name": "E2E-LB-2"
      },
      "appliance_instance": [
        {
          "id": "23422",
          "run": null,
          "context": {
            "lb_name": "LB-NLB-26321-4626",
            "lb_type": "external",
            "lb_mode": "TCP",
            "lb_port": "12345",
            "plan_name": "E2E-LB-2",
            "node_list_type": "D",
            "enable_bitninja": false,
            "security_group_id": 81526,
            "host_target": "164.52.192.224",
            "management_ip": "192.168.0.204"
          }
        }
      ],
      "created_at": "2026-06-09 06:09:17 AM UTC",
      "updated_at": "2026-06-09 06:09:17 AM UTC",
      "eos_enabled_status": false,
      "project_name": "default-project-33935",
      "isEncryptionEnabled": true
    }
  ],
  "message": "Success",
  "total_page_number": 1,
  "total_count": 1
}