Versions Compared
Key
- This line was added.
- This line was removed.
- Formatting was changed.
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
Code Block | ||
---|---|---|
| ||
{ "data": [ { "uuid": "e32adcfd-0a01-47e1-8187-b9ee0055dc02", "label": "Blue", "type": "Display", "attributes": { "draw_text": true, "decay_time": 30, "blink_color": "Blue", "draw_border": false, "active_color": "Blue", "border_color": "Blue", "non_active_color": "Black" }, "modified": "2021-07-04T07:46:08.869Z", "created": "2021-07-04T07:46:08.869Z" }, { "uuid": "aac5c67e-cbae-432a-a7c7-279a521bba12", "label": "Email", "type": "EMAIL", "attributes": { "ssl": true, "from": "mcm9000", "host": "smtp.gmail.com", "port": "587", "password": "example", "username": "test@gmail.com", "recipients": [ "test@example.com" ], "send_clear": true, "errors_queue_size": 100, "min_email_interval": 60 }, "modified": "2021-07-04T07:46:08.869Z", "created": "2021-07-04T07:46:08.869Z" }, { "uuid": "e32adcfd-0a01-47e1-8187-b9ee0055dc04", "label": "Green", "type": "Display", "attributes": { "draw_text": true, "decay_time": 30, "blink_color": "Green", "draw_border": false, "active_color": "Green", "border_color": "Green", "non_active_color": "Black" }, "modified": "2021-07-04T07:46:08.869Z", "created": "2021-07-04T07:46:08.869Z" }, { "uuid": "7d6b7ef6-4a5d-427b-8389-75d600a30098", "label": "new_Audio", "type": "Audio", "attributes": { "duration": null, "for_displayed_only": true, "ignore_acknowledged": true }, "modified": "2021-08-01T13:24:36.319Z", "created": "2021-08-01T13:24:36.319Z" }, { "uuid": "e32adcfd-0a01-47e1-8187-b9ee0055dc01", "label": "Red", "type": "Display", "attributes": { "draw_text": true, "decay_time": 30, "blink_color": "Red", "draw_border": true, "active_color": "Red", "border_color": "Red", "non_active_color": "Black" }, "modified": "2021-07-04T07:46:08.869Z", "created": "2021-07-04T07:46:08.869Z" }, { "uuid": "aac5c67e-cbae-432a-a7c7-279a521bba10", "label": "SNMP", "type": "SNMP", "attributes": { "port": 162, "network": null, "community": "public", "ip_address": "192.168.0.85", "send_clear": true, "keep_alive_interval": null }, "modified": "2021-07-04T07:46:08.869Z", "created": "2021-07-04T07:46:08.869Z" }, { "uuid": "aac5c67e-cbae-432a-a7c7-279a521bba11", "label": "SYSLOG", "type": "SYSLOG", "attributes": { "port": 514, "network": null, "ip_address": "192.168.0.100", "send_clear": true, "keep_alive_interval": null }, "modified": "2021-07-04T07:46:08.869Z", "created": "2021-07-04T07:46:08.869Z" }, { "uuid": "b93e1865-497d-4f48-b965-848b4433e1cc", "label": "test", "type": "Display", "attributes": { "draw_text": true, "decay_time": 10, "blink_color": "Red", "draw_border": true, "active_color": "Red", "border_color": "Red", "non_active_color": "Black" }, "modified": "2021-09-12T15:09:04.520Z", "created": "2021-09-12T15:09:04.520Z" }, { "uuid": "e32adcfd-0a01-47e1-8187-b9ee0055dc03", "label": "Yellow", "type": "Display", "attributes": { "draw_text": true, "decay_time": 30, "blink_color": "Yellow", "draw_border": false, "active_color": "Yellow", "border_color": "Yellow", "non_active_color": "Black" }, "modified": "2021-07-04T07:46:08.869Z", "created": "2021-07-04T07:46:08.869Z" } ], "metadata": { "item_count": 9, "total_items": 9, "current_page": 1, "sort_by": [ { "field": "label", "direction": "ASC" } ], "links": { "current": "http://192.168.0.22/api/5.0/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
Code Block | ||
---|---|---|
| ||
{ "data": [ { "uuid": "b93e1865-497d-4f48-b965-848b4433e1cc", "label": "test", "created": "2021-09-12T15:09:04.520Z", "modified": "2021-09-12T15:09:04.520Z", "type": "Display", "attributes": { "active_color": "Red", "non_active_color": "Black", "decay_time": 10, "draw_border": true, "draw_text": true, "border_color": "Red", "blink_color": "Red" } } ], "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
Code Block | ||
---|---|---|
| ||
{ "Typesdisplay": [{ "SNMPActiveColors",: [ "SYSLOG", "Red", "Display", "EMAILBlue", "CEDGreen", "AudioOrange", "RecordingYellow", "Redis" "Light ]Blue", "display": { "Light "ActiveColors": [Green", "RedPink", "BlueBlack", "Green",White" ], "OrangeNonActiveColors",: [ "YellowRed", "Light Blue", "Light Green", "PinkOrange", "BlackYellow", "WhiteLight Blue", ], "NonActiveColors": ["Light Green", "RedPink", "BlueBlack", "Green",White" ], "OrangeBorderColors",: [ "YellowRed", "Light Blue", "Light Green", "PinkOrange", "BlackYellow", "WhiteLight Blue", ], "BorderColors": ["Light Green", "RedPink", "BlueBlack", "Green",White" ], "OrangeBlinkColors",: [ "YellowRed", "Light Blue", "Light Green", "PinkOrange", "BlackYellow", "WhiteLight Blue", ], "BlinkColors": ["Light Green", "RedPink", "BlueBlack", "GreenWhite", ] "Orange"}, "Types": [ "YellowDisplay", "Light Blue"SNMP", "Light GreenEMAIL", "PinkSYSLOG", "BlackAudio", "WhiteRecording" ] } } |
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
Code Block | ||
---|---|---|
| ||
{ "data": [ { "success": true } ], "metadata": {} } |
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
Code Block | ||
---|---|---|
| ||
{ "label": "SNMP_edited", "type": "SNMP", "attributes": { "ip_address": "192.168.0.85", "port": 162, "keep_alive_interval": null, "network": null, "community": "public", "send_clear": true } } |
Response
Code Block | ||
---|---|---|
| ||
{ "data": [ { "uuid": "c45fd6ce-99a3-4056-ab83-6265e30acc45", "label": "SNMP_edited", "created": "2021-09-21T06:46:34.041Z", "modified": "2021-09-21T06:47:43.306Z", "type": "SNMP", "attributes": { "ip_address": "192.168.0.85", "port": 162, "keep_alive_interval": null, "network": null, "community": "public", "send_clear": true } } ], "metadata": {} } |
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
Code Block | ||
---|---|---|
| ||
{ "label": "SNMP_test", "type": "SNMP", "attributes": { "ip_address": "192.168.0.85", "port": 162, "keep_alive_interval": null, "network": null, "community": "public", "send_clear": true } } |
Response
Code Block | ||
---|---|---|
| ||
{ "data": [ { "uuid": "c45fd6ce-99a3-4056-ab83-6265e30acc45", "label": "SNMP_test", "created": "2021-09-21T06:46:34.041Z", "modified": "2021-09-21T06:46:34.041Z", "type": "SNMP", "attributes": { "ip_address": "192.168.0.85", "port": 162, "keep_alive_interval": null, "network": null, "community": "public", "send_clear": true } } ], "metadata": {} } |