Config

List all monitoring groups

Returns the list of monitoring groups (the Groups block on /admin/config/networking/monitoring). Supports the standard Splynx list query parameters (search[main_attributes][...], order, limit, offset).

get/admin/config/monitoring-groups

Request

Base URL: https://demo.splynx.com/api/2.0
URL: https://demo.splynx.com/api/2.0/admin/config/monitoring-groups
Auth: HTTP basic

Response

idnumber

Monitoring group ID.

titlestring

Group name.

delay_timernumber

Delay (in minutes) before notifications are sent for the group.

panel_notificationsboolean

Whether panel (in-app) notifications are enabled for the group.

email_notificationsboolean

Whether email notifications are enabled for the group.

email_notification_subjectstring

Subject template used for the group's email notifications.

email_notifications_template_idnumber nullable

Email template ID used for the group's notifications.

notifications_adminsnumber[]

Administrator IDs that receive notifications for the group.

sms_notificationsboolean

Whether SMS notifications are enabled for the group.

sms_notifications_template_idnumber nullable

SMS template ID used for the group's notifications.

Example response

[
  {
    "id": 2,
    "title": "Core devices",
    "delay_timer": 5,
    "panel_notifications": true,
    "email_notifications": true,
    "email_notification_subject": "[Splynx] Monitoring alert",
    "email_notifications_template_id": 1,
    "notifications_admins": [
      1,
      2
    ],
    "sms_notifications": false,
    "sms_notifications_template_id": 1
  }
]

Changes

No recorded changes to this operation across all 1 revision of this API.