Organizations
Get cluster node list
Retrieves a hierarchical list of all nodes in the OpenObserve cluster organized by regions and clusters, with detailed information about each node including versions and roles. Useful for monitoring cluster health and managing distributed deployments.
get/api/{org_id}/node/list
Request
- Base URLhttps://api.openobserve.ai (the document declares no server; this is the origin it was published from)
- AuthAPI key in header Authorization
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Path parameters
org_idstring required
Must be '_meta'
Query parameters
regionsstring
Optional comma-separated list of regions to filter by (e.g., 'us-east-1,us-west-2')
Response
Success
object required
Response struct for node listing with nested hierarchy
Contains a three-level hierarchy with a flat format:
- Regions at the top level as object keys
- Clusters within each region as object keys
- Nodes as arrays directly under each cluster
Changes
No recorded changes to this operation across all 1 revision of this API.