Skip to main content

Perform Load Balancer Action

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!.

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

Path parameters

  • lb_idPathintegerrequired

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

    • required
    • must be a valid load balancer (appliance) ID
    example12345

Query parameters

  • project_idQueryintegerrequired

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

    • required
    • must be a valid integer project ID
    example{{project_id}}
  • apikeyQuerystringrequired

    API key used to authenticate the request

    • required
    • non-empty string
    example{{api_key}}
  • locationQuerystringrequired

    Region of the target load balancer.

    • required
    • non-empty string
    example{{location}}

Request body

application/json

object
typestringrequiredpower_on | power_off | upgrade_plan…

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

examplepower_off
  • required
  • must be one of the supported action identifiers
plan_namestring

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

exampleE2E-LB-3
  • required when type is upgrade_plan
  • must reference an existing load balancer plan in the region
namestring

New display name. Required when type is rename.

examplenew-name
  • required when type is rename
  • matches ^[A-Za-z0-9_-]+$
  • max length 64 characters

Responses

200Successful response
object
codeinteger
example200
datastring

Human-readable result of the action.

exampleAppliance Powering Off
errorsobject
messagestring
exampleSuccess