Skip to main content

List Load Balancers

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.

GET/api/v1/appliances/

Query parameters

  • page_noQueryintegeroptional

    1-based page number to retrieve.

    • optional
    • positive integer
    • defaults to 1 when omitted
    example1
  • per_pageQueryintegeroptional

    Number of load balancers to return per page.

    • optional
    • positive integer
    example5
  • advance_search_stringQuerybooleanoptional

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

    • optional
    • boolean
    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 request

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

    Region to filter load balancers by.

    • must be a non-empty string
    example{{location}}

Responses

200Successful response
object
codeinteger
example200
dataarray
errorsobject
messagestring
exampleSuccess
total_page_numberinteger
example1
total_countinteger
example1