Skip to main content

Load Balancer Stats

Returns live HAProxy runtime statistics for a single load balancer, grouped into frontends, backends, and servers. The fields mirror the HAProxy stats CSV (sessions, bytes in/out, queue depth, response code counts, health-check status, and so on) and are useful for building custom dashboards. For historical time-series data use Historical Data instead.

GET/api/v1/appliances/load-balancers/{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

  • 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 load balancer.

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

Responses

200Successful response
object

Live HAProxy statistics. frontends, backends, and servers are arrays whose objects mirror the HAProxy stats CSV columns (only the commonly used columns are shown here).

codeinteger
example200
dataobject
errorsobject
messagestring
exampleSuccess