Skip to main content

Delete Load Balancer

Permanently deletes a load balancer appliance. Note the path uses the generic appliances/{lb_id}/ route, not the load-balancers/ prefix. Use the reserve_ip_required query parameter to decide whether the load balancer's public IP should be retained as a reserved IP on the account after deletion. This action cannot be undone.

DELETE/api/v1/appliances/{lb_id}/

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

  • reserve_ip_requiredQuerybooleanoptional

    When true, the load balancer's public IP is converted to a reserved IP on the account instead of being released.

    • optional
    • boolean
    • defaults to false
    examplefalse
  • 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 delete request

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

    Region of the load balancer being deleted.

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

Responses

200Successful response
object
codeinteger
example200
dataobject
errorsobject
messagestring
exampleSuccess