Examples

GET /api/dashboard
200
{
  "total_hosts": 0,
  "bad_hosts": 0,
  "bad_hosts_enabled": 0,
  "active_hosts": 0,
  "active_hosts_ok": 0,
  "active_hosts_ok_enabled": 0,
  "ok_hosts": 0,
  "ok_hosts_enabled": 0,
  "disabled_hosts": 0,
  "pending_hosts": 0,
  "pending_hosts_enabled": 0,
  "out_of_sync_hosts": 0,
  "out_of_sync_hosts_enabled": 0,
  "good_hosts": 0,
  "good_hosts_enabled": 0,
  "percentage": 0,
  "reports_missing": 0,
  "glossary": {
    "total_hosts": "Total hosts count",
    "bad_hosts": "Hosts with error state",
    "bad_hosts_enabled": "Hosts with error state and alerts enabled",
    "active_hosts": "Hosts which recently applied changes",
    "active_hosts_ok": "Hosts which recently applied changes successfully",
    "active_hosts_ok_enabled": "Hosts which recently applied changes successfully with alerts enabled",
    "ok_hosts": "Hosts without changes or errors",
    "ok_hosts_enabled": "Hosts without changes or errors, with alerts enabled",
    "out_of_sync_hosts": "Out of sync hosts",
    "out_of_sync_hosts_enabled": "Out of sync hosts with alerts enabled",
    "disabled_hosts": "Hosts with alerts disabled",
    "pending_hosts": "Hosts that had pending changes",
    "pending_hosts_enabled": "Hosts that had pending changes with alerts enabled",
    "good_hosts": "Hosts without errors",
    "good_hosts_enabled": "Hosts without errors, with alerts enabled",
    "percentage": "Hosts without errors percent",
    "reports_missing": "Hosts which are not reporting"
  }
}

Params

Param Name Description
location_id
Optional

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
Optional

Set the current organization context for the request

Validations:

  • Must be a Integer

search
Optional

filter results

Validations:

  • Must be a String