Load Balancer Actions — API

Query parameters

appliance_idQueryintegerrequired
Appliance ID
project_idQueryintegerrequired
Project ID Find your project id here
locationQuerystringrequired
Location (Delhi and Chennai)

Request body

application/json

object

typestringrequiredpower_off | upgrade_plan

The type of operation to be performed on the device (e.g., power_off, upgrade_plan).

examplepower_off

namestring

Name of the LB to upgrade plan (Required in upgrade_plan action )

exampleE2E-LB-1-887

plan_namestring

plan_name from available plans (required for upgrade_plan action)

exampleE2E-LB-4

Responses

200Successful response with a message indicating the appliance status.

object

codeinteger

example200

datastring

example["Appliance Powering Off","lb node upgrading"]

errorsobject

messagestring

exampleSuccess

Request

curl -X PUT 'https://api.e2enetworks.com/myaccount/appliances/load-balancers/{appliance_id}/actions/?appliance_id=%3Cappliance_id%3E&project_id=%3Cproject_id%3E&location=%3Clocation%3E&apikey=%3Capikey%3E' \
  -H 'Authorization: Bearer <JWT>' \
  -H 'Content-Type: application/json' \
  -d '{
  "type": "power_off",
  "name": "E2E-LB-1-887",
  "plan_name": "E2E-LB-4"
}'

Response · 200

{
  "code": 200,
  "data": [
    "Appliance Powering Off",
    "lb node upgrading"
  ],
  "errors": {},
  "message": "Success"
}