v5.1_Notification Agents
- Ramya Raman (Unlicensed)
Analytics
GET notification_agents/config
Resource Information
Requires Authentication? | |
Response Formats | json |
HTTP Methods | GET |
Returns a list of all Notification agents in the system, with its main configuration data.
Resource URL
https://{{ip_address}}:{{port}}/api/{{version}}/notification_agents/config
Example Request
GET
{
"data": [
{
"uuid": "4986c1a5-926b-45e0-8a86-5d20a6ee8efd",
"label": "aud",
"created": "2022-08-22T11:35:16.104Z",
"modified": "2023-08-16T12:43:42.550Z",
"type": "Audio",
"attributes": {
"ignore_acknowledged": true
}
},
{
"uuid": "b978c720-c8ab-4152-80d9-4363dfb3e1d3",
"label": "audio_test",
"created": "2023-01-11T15:01:17.870Z",
"modified": "2023-08-16T12:43:42.550Z",
"type": "Audio",
"attributes": {
"ignore_acknowledged": true
}
},
{
"uuid": "e32adcfd-0a01-47e1-8187-b9ee0055dc02",
"label": "Blue",
"created": "2022-06-01T08:52:54.562Z",
"modified": "2022-06-27T13:14:34.649Z",
"type": "Display",
"attributes": {
"active_color": "Blue",
"non_active_color": "Black",
"decay_time": 30,
"draw_border": false,
"draw_text": true,
"border_color": "Blue",
"blink_color": "Blue"
}
},
{
"uuid": "3d93782e-bb0e-410b-a3b4-7d5e40ad8d2b",
"label": "Blue_Display",
"created": "2023-01-11T14:13:36.791Z",
"modified": "2023-01-11T14:13:36.791Z",
"type": "Display",
"attributes": {
"active_color": "Blue",
"non_active_color": "Light Blue",
"decay_time": 10,
"draw_border": true,
"draw_text": true,
"border_color": "Blue",
"blink_color": "Blue"
}
},
{
"uuid": "e32adcfd-0a01-47e1-8187-b9ee0055dc04",
"label": "Green",
"created": "2022-06-01T08:52:54.562Z",
"modified": "2022-06-27T13:14:34.649Z",
"type": "Display",
"attributes": {
"active_color": "Green",
"non_active_color": "Black",
"decay_time": 30,
"draw_border": false,
"draw_text": true,
"border_color": "Green",
"blink_color": "Green"
}
},
{
"uuid": "e32adcfd-0a01-47e1-8187-b9ee0055dc01",
"label": "Red",
"created": "2023-04-13T11:03:11.653Z",
"modified": "2023-04-13T11:03:11.653Z",
"type": "Display",
"attributes": {
"active_color": "Red",
"non_active_color": "Black",
"decay_time": 30,
"draw_border": true,
"draw_text": true,
"border_color": "Red",
"blink_color": "Red"
}
},
{
"uuid": "e32adcfd-0a01-47e1-8187-b9ee0055dc03",
"label": "Yellow",
"created": "2023-04-13T11:03:11.653Z",
"modified": "2023-04-13T11:03:11.653Z",
"type": "Display",
"attributes": {
"active_color": "Yellow",
"non_active_color": "Black",
"decay_time": 30,
"draw_border": false,
"draw_text": true,
"border_color": "Red",
"blink_color": "Yellow"
}
},
{
"uuid": "aac5c67e-cbae-432a-a7c7-279a521bba12",
"label": "Email",
"created": "2022-06-01T08:52:54.562Z",
"modified": "2022-06-27T13:14:34.649Z",
"type": "EMAIL",
"attributes": {
"from": "mcm9000",
"host": "smtp.gmail.com",
"port": 587,
"ssl": true,
"username": "test@gmail.com",
"password": "example",
"recipients": [
"test@example.com"
],
"min_email_interval": 60,
"errors_queue_size": 100,
"send_clear": true
}
},
{
"uuid": "3cb95e5f-5ad2-46f3-95c6-c1b21a3315bc",
"label": "rec1",
"created": "2022-12-23T17:42:31.459Z",
"modified": "2022-12-23T17:42:31.459Z",
"type": "Recording",
"attributes": {
"pid_filtering": false,
"rec_before_trigger": 5,
"rec_after_trigger": 5,
"max_recording_time": 120,
"max_file_size": null,
"target": {
"storage_type": "FTP",
"host": "1.1.1.3",
"path_on_target": "",
"bandwidth_limit": 100000,
"network": "Auto",
"port": 21,
"storage_limit": "None",
"username": "",
"password": ""
}
}
},
{
"uuid": "aac5c67e-cbae-432a-a7c7-279a521bba10",
"label": "SNMP",
"created": "2022-06-01T08:52:54.562Z",
"modified": "2022-06-27T13:14:34.649Z",
"type": "SNMP",
"attributes": {
"ip_address": "192.168.0.85",
"port": 162,
"keep_alive_interval": "None",
"network": "Auto",
"community": "public",
"send_clear": true
}
},
{
"uuid": "c20efdf0-f32e-4c36-b0eb-544c3a083e93",
"label": "SNMP_test",
"created": "2023-01-11T14:28:28.015Z",
"modified": "2023-01-11T14:28:28.015Z",
"type": "SNMP",
"attributes": {
"ip_address": "192.168.0.85",
"port": 162,
"keep_alive_interval": "None",
"network": "Auto",
"community": "public",
"send_clear": false
}
},
{
"uuid": "aac5c67e-cbae-432a-a7c7-279a521bba11",
"label": "SYSLOG",
"created": "2022-06-01T08:52:54.562Z",
"modified": "2022-06-27T13:14:34.649Z",
"type": "SYSLOG",
"attributes": {
"ip_address": "192.168.0.100",
"port": 514,
"network": "Auto",
"keep_alive_interval": "None",
"send_clear": true
}
},
{
"uuid": "8e2dcc46-e79f-4d4b-96e3-d4aeaf4762ad",
"label": "syslog_test",
"created": "2023-01-11T14:56:26.982Z",
"modified": "2023-01-11T14:56:26.982Z",
"type": "SYSLOG",
"attributes": {
"ip_address": "192.168.10.10",
"port": 514,
"network": "Auto",
"keep_alive_interval": "None",
"send_clear": false
}
}
],
"metadata": {
"item_count": 13,
"total_items": 13,
"current_page": 1,
"sort_by": [
{
"type": "ASC"
},
{
"label": "ASC"
}
],
"links": {
"current": "http://192.168.10.53/api/5.1/notification_agents/config"
}
}
}
GET notification_agents/config/{uuid}
Resource Information
Requires Authentication? | |
Response Formats | json |
HTTP Methods | GET |
Returns an extended single Notification agents configuration view, specified by the required {uuid} parameter.
Resource URL
https://{{ip_address}}:{{port}}/api/{{version}}/notification_agents/config/{{uuid}}
Parameters
Parameter | Data Type | Description |
|---|---|---|
uuid | string | The UUID of the desired notification agents. |
Example Request
GET
{
"data": {
"uuid": "e32adcfd-0a01-47e1-8187-b9ee0055dc04",
"label": "Green",
"created": "2022-06-01T08:52:54.562Z",
"modified": "2022-06-27T13:14:34.649Z",
"type": "Display",
"attributes": {
"active_color": "Green",
"non_active_color": "Black",
"decay_time": 30,
"draw_border": false,
"draw_text": true,
"border_color": "Green",
"blink_color": "Green"
}
},
"metadata": {}
}
GET notification agents/config/meta
Resource Information
Requires Authentication? | |
Response Formats | json |
HTTP Methods | GET |
Returns all meta data used by Notification agents configuration.
Resource URL
https://{{ip_address}}:{{port}}/api/{{version}}/notification_agents/config/meta
Example Request
GET
{
"display": {
"ActiveColors": [
"Red",
"Blue",
"Green",
"Orange",
"Yellow",
"Light Blue",
"Light Green",
"Pink",
"Black",
"White"
],
"NonActiveColors": [
"Red",
"Blue",
"Green",
"Orange",
"Yellow",
"Light Blue",
"Light Green",
"Pink",
"Black",
"White"
],
"BorderColors": [
"Red",
"Blue",
"Green",
"Orange",
"Yellow",
"Light Blue",
"Light Green",
"Pink",
"Black",
"White"
],
"BlinkColors": [
"Red",
"Blue",
"Green",
"Orange",
"Yellow",
"Light Blue",
"Light Green",
"Pink",
"Black",
"White"
]
},
"Types": [
"Display",
"SNMP",
"EMAIL",
"SYSLOG",
"Audio",
"Recording"
]
}
DELETE notification agents/config/{uuid}
Resource Information
Requires Authentication? | |
Response Formats | json |
HTTP Methods | DELETE |
Delete a specific Notification agents configuration.
Resource URL
https://{{ip_address}}:{{port}}/api/{{version}}/notification_agents/config/{{uuid}}
Parameters
Parameter | Data Type | Description |
|---|---|---|
uuid | string | The UUID of the notification agents to be deleted. |
Example Request
DELETE
PUT notification_agents/config/{uuid}
Resource Information
Requires Authentication? | |
Response Formats | json |
HTTP Methods | PUT |
Edit a Notification agents configuration.
Resource URL
https://{{ip_address}}:{{port}}/api/{{version}}/notification_agents/config/{{uuid}}
Parameters
Parameter | Data Type | Description |
|---|---|---|
uuid | string | The UUID of the notification agents to be edited. |
Example Request
PUT
Body
Response
POST notification agents/config
Resource Information
Requires Authentication? | |
Response Formats | json |
HTTP Methods | POST |
Add a new Notification agents, configured according to the attached data request.
Resource URL
https://{{ip_address}}:{{port}}/api/{{version}}/notification_agents/config
Example Request
POST
Body
Response
POST notification agents/config multi
Resource Information
Requires Authentication? | |
Response Formats | json |
HTTP Methods | POST |
Add multiple Notification agents, configured according to the attached data request.
Resource URL
https://{{ip_address}}:{{port}}/api/{{version}}/notification_agents/config
Example Request
POST
Body
Response
PUT notification agents/config multi
Resource Information
Requires Authentication? | |
Response Formats | json |
HTTP Methods | PUT |
Edit multiple Notification agents, configured according to the attached data request.
Resource URL
https://{{ip_address}}:{{port}}/api/{{version}}/notification_agents/config
Example Request
PUT
Body
Response
DELETE notification agents/config multi
Resource Information
Requires Authentication? | |
Response Formats | json |
HTTP Methods | DELETE |
Delete multi Notification agents configuration.
Resource URL
https://{{ip_address}}:{{port}}/api/{{version}}/notification_agents/config/{{uuid}}
Example Request
DELETE
Body
Response