×
![]()
Runtime - Monitoring Clusters
This section is for searching for live objects being monitored by Opsview. This is in the Runtime database, hence the URL path is /rest/runtime/{objecttype}.
URL: /rest/runtime/monitoringcluster
Requires authentication - requires VIEWALL or VIEWSOME permission.
GET— returns monitoring clusters.POST,PUT,DELETE— not implemented.
Access Control Copied
VIEWALLallows all monitoring clusters to be returned.VIEWSOMEonly lists monitoring clusters that are associated to objects where permission has been granted based on the access object selection.
Retrieving Monitoring Clusters Copied
Response:
list— an array of the results.
Where list is an associative array of the results, consisting of:
id— ID number of the monitoring cluster. id=1 means it is the primary cluster.name— Name of the monitoring cluster.activated— Either 0 or 1.
Example response:
{
"list": [
{
"activated": "1",
"id": 1,
"name": "Master Monitoring Server",
"passive": "0" // Unused
},
{
"activated": "1",
"id": 2,
"name": "ClusterA",
"passive": "0"
},
{
"activated": "1",
"id": 3,
"name": "Cluster",
}
],
}
["Opsview On-Premises"]
["API", "Technical Reference"]