Skip to main content

Get Node Server Health Metrics

Returns time-series health metrics for a single node belonging to the auto scaling group - memory, disk and CPU utilisation, disk IOPS, and per-NIC network in/out throughput. Each metric is a { labels, results } pair (labels are timestamps, results are values). The path takes the node id (from Active Node Details), not the scale group id. Use the interval query parameter to set the look-back window in seconds.

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

Path parameters

  • node_idPathintegerrequired

    The id of the group's node (from Active Node Details).

    • required
    • must be a valid node ID belonging to the group
    example12345

Query parameters

  • intervalQueryintegeroptional

    Look-back window for the metrics, in seconds.

    • optional
    • positive integer (seconds)
    • defaults to 3600 (1 hour)
    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 node.

    • required
    • must be a valid region name (e.g., Delhi, Chennai)
    example{{location}}

Responses

200Successful response
object

Time-series health metrics for a node. Each metric is a { labels, results } pair - labels are timestamps and results are the values at those times.

codeinteger
example200
dataobject
errorsobject
messagestring
exampleSuccess