Skip to main content

List Monitored Cluster Nodes

Returns the cluster's nodes as seen by monitoring - each node's id, name, vm_id, public/private IP, status, vm_type (master/worker), monitor status, and whether the monitoring and alert tabs are enabled for it. Use the cluster service_id. The node id/vm_id from here feeds Server Health and the alert operations.

GET/api/v1/kubernetes/k8s-monitoring-nodes/{service_id}/

Path parameters

  • service_idPathintegerrequired

    The cluster service_id, as returned by List.

    • required
    • must be a valid cluster service 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 cluster.

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

Responses

200Successful response
object
codeinteger
example200
dataarray

Cluster nodes as seen by monitoring.

errorsobject
messagestring
exampleSuccess