Perform Load Balancer Action

PUT

/api/v1/appliances/load-balancers/{lb_id}/actions/

curl --request PUT \
  --url 'https://api.e2enetworks.com/myaccount/api/v1/appliances/load-balancers/{lb_id}/actions/?project_id=<PROJECT_ID>&apikey=<API_KEY>&location=<LOCATION>' \
  --header 'Authorization: Bearer <API_TOKEN>' \
  --header 'Content-Type: application/json' \
  --data '{
  "type": "power_off",
  "plan_name": "E2E-LB-3",
  "name": "new-name"
}'

import requests

response = requests.put(
    "https://api.e2enetworks.com/myaccount/api/v1/appliances/load-balancers/{lb_id}/actions/",
    params={"project_id": "<PROJECT_ID>", "apikey": "<API_KEY>", "location": "<LOCATION>"},
    headers={"Authorization": "Bearer <API_TOKEN>"},
    json={
        "type": "power_off",
        "plan_name": "E2E-LB-3",
        "name": "new-name",
    },
)
print(response.json())

const url = new URL("https://api.e2enetworks.com/myaccount/api/v1/appliances/load-balancers/{lb_id}/actions/");
url.search = new URLSearchParams({ project_id: "<PROJECT_ID>", apikey: "<API_KEY>", location: "<LOCATION>" });

const response = await fetch(url, {
  method: "PUT",
  headers: { "Authorization": "Bearer <API_TOKEN>", "Content-Type": "application/json" },
  body: JSON.stringify({
    "type": "power_off",
    "plan_name": "E2E-LB-3",
    "name": "new-name"
  }),
});
console.log(await response.json());

Performs a lifecycle or management action on a single load balancer. The action is selected by the type field in the request body. Two actions require an extra field: upgrade_plan requires plan_name, and rename requires name. All other actions need only type.

Supported actions: power_on, power_off, upgrade_plan, rename. Any other value is rejected with Invalid Action!.

Parameters

Path Parameters

lb_id

required

integer

The id of the load balancer, as returned by the List Load Balancers endpoint.

Example

Query Parameters

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 of the target load balancer.

Example

<LOCATION>

Request Body

application/json

object

type

required

Action to perform. upgrade_plan additionally requires plan_name; rename additionally requires name. power_on and power_off need only type.

string

Allowed values: power_on power_off upgrade_plan rename

Example

power_off

plan_name

Target plan SKU. Required when type is upgrade_plan. Must be a larger plan than the current one.

string

Example

E2E-LB-3

name

New display name. Required when type is rename.

string

Example

new-name

Responses

200

Successful response

application/json

object

code

integer

data

Human-readable result of the action.

string

errors

object

message

string

Example

{
  "code": 200,
  "data": "Appliance Powering Off",
  "message": "Success"
}