Skip to main content

Server Health

Returns node-level health time-series (memory, disk, CPU load/utilization, disk read/write IOPS, and per-interface network in/out) for the load balancer's underlying node over the requested interval. The node_id path parameter is the load balancer's node_detail.node_id. Each metric is returned as aligned labels (timestamps) and results arrays.

GET/api/v1/nodes/{node_id}/monitor/server-health/

Path parameters

  • node_idPathintegerrequired

    The node_id field from the node_detail object in the List Load Balancers response.

    • required
    • must be a valid node ID
    example23456

Query parameters

  • intervalQueryintegeroptional

    Look-back window in seconds. Defaults to 3600 (1 hour).

    • optional
    • positive integer (seconds)
    example3600
  • 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

Each metric is an object of aligned labels (timestamps) and results (values). network is keyed by interface name, each with in and out series.

codeinteger
example200
dataobject
errorsobject
messagestring
exampleSuccess