Request URL
GET https://api.dotcom-monitor.com/config_api_v1/group/{group_id}
Path Parameters
| Field | Type | Required | Description |
|---|---|---|---|
| group_id |
string |
true |
The Group unique id. |
Success Response
Fields Description
| Field | Type | Description |
| Id |
Int32 |
Unique Notification group ID
Example:
“Id”: 613 |
| Name |
String |
Notification Group name
Example:
“Name”: “Notification Group” |
| Scheduler_Id |
Int32 |
ID of a scheduler assigned to a notification group. “0” value means there is no scheduler assigned to a group.
Example:
“Scheduler_Id”: 0 |
| Addresses |
Array of Objects |
Possible Types of notification addresses: “Email”, “Script”, “Phone”, “Snmp”, “Pager”, “Sms”, “Wireless”.
Each notification address type has its own set of fields. “Email” Example:
{
"Address": "alerts@company.com",
"Template_Id": 0,
"Type": "Email"
}
“Script” Example:
{
"File": "url_executor.cs \"address.com\"",
"Template_Id": 0,
"Type": "Script"
}
“Phone” Example:
{
"Code": "011",
"Number": "1234567",
"Template_Id": 0,
"Type": "Phone"
}
“Snmp” Example:
{
"Community": "public",
"Host": "127.0.0.1",
"Template_Id": 0,
"Type": "Snmp"
}
“Sms” Example:
{
"Number": "0111234567",
"Template_Id": 0,
"Type": "Sms"
}
“Wireless” Example:
{
"WirelessDeviceEmail": "wireless@company.com",
"Template_Id": 0,
"Type": "Wireless"
}
|
| Assigned_To |
Array containing int32 |
This array contains list of device ids where notification group was assigned.
Example:
"Assigned_To": [8533, 8534,9756] |
