api.mon.base

/mon/template

api.mon.base.views.mon_template_list(*args, **kwargs)

Get (GET)

GET /mon/template
DC-bound?:
Permissions:
Asynchronous?:
  • ✓ - List of monitoring templates is retrieved from monitoring server
  • ✗ - List of monitoring templates is retrieved from cache
Parameters:
  • data.full (boolean) – Return list of objects with all monitoring template details (default: false)
Status Codes:

/mon/hostgroup

api.mon.base.views.mon_hostgroup_list(*args, **kwargs)

Get (GET)

GET /mon/hostgroup
DC-bound?:
  • ✓ - dc_bound=true
  • ✗ - dc_bound=false
Permissions:
Asynchronous?:
  • ✓ - List of monitoring hostgroups is retrieved from monitoring server
  • ✗ - List of monitoring hostgroups is retrieved from cache
Parameters:
  • data.full (boolean) – Return list of objects with all monitoring hostgroup details (default: false)
  • data.dc_bound (boolean) – If false, include information about “global” monitoring hostgroups that are not bound to a datacenter (requires SuperAdmin permission) (default: true)
Status Codes:

/mon/hostgroup/(hostgroup_name)

api.mon.base.views.mon_hostgroup_manage(*args, **kwargs)

Show (GET), create (POST) or remove (DELETE) a monitoring hostgroup.

GET /mon/hostgroup/(hostgroup_name)
DC-bound?:
  • ✓ - dc_bound=true
  • ✗ - dc_bound=false
Permissions:
Asynchronous?:
Parameters:
  • hostgroup_name (string) – required - Monitoring hostgroup name
  • data.dc_bound (boolean) – If false, display a “global” monitoring hostgroup that is not bound to a datacenter (requires SuperAdmin permission) (default: true)
Status Codes:
POST /mon/hostgroup/(hostgroup_name)
DC-bound?:
  • ✓ - dc_bound=true
  • ✗ - dc_bound=false
Permissions:
Asynchronous?:
Parameters:
  • hostgroup_name (string) – required - Monitoring hostgroup name
  • data.dc_bound (boolean) – If false, create a “global” monitoring hostgroup that is not bound to a datacenter (requires SuperAdmin permission) (default: true)
Status Codes:
DELETE /mon/hostgroup/(hostgroup_name)
DC-bound?:
  • ✓ - dc_bound=true
  • ✗ - dc_bound=false
Permissions:
Asynchronous?:
Parameters:
  • hostgroup_name (string) – required - Monitoring hostgroup name
  • data.dc_bound (boolean) – If false, delete a “global” monitoring hostgroup that is not bound to a datacenter (requires SuperAdmin permission) (default: true)
Status Codes: