- Created by Ramya Raman on Oct 06, 2021
You are viewing an old version of this page. View the current version.
Compare with Current View Page History
Version 1 Next »
GET notifications/config
Resource Information
Requires Authentication? | |
Response Formats | json |
HTTP Methods | GET |
Returns a list of all Notifications in the system, with its main configuration data.
Resource URL
https://{{ip_address}}:{{port}}/api/{{version}}/notifications/config
Example Request
GET
{
"data": [
{
"uuid": "f3a31bc3-e53f-4b63-9605-cd0b6121e602",
"label": "Default",
"entries": [
{
"type": "Display",
"agent": "e32adcfd-0a01-47e1-8187-b9ee0055dc01",
"severity": "Critical"
},
{
"type": "Display",
"agent": "e32adcfd-0a01-47e1-8187-b9ee0055dc02",
"severity": "Major"
},
{
"type": "Display",
"agent": "e32adcfd-0a01-47e1-8187-b9ee0055dc03",
"severity": "Minor"
},
{
"type": "Display",
"agent": "e32adcfd-0a01-47e1-8187-b9ee0055dc04",
"severity": "Warning"
},
{
"type": "Audio",
"agent": "7d6b7ef6-4a5d-427b-8389-75d600a30098",
"severity": "Critical"
}
],
"modified": "2021-08-01T13:24:44.662Z",
"created": "2021-07-04T07:46:08.869Z"
},
{
"uuid": "d1469056-5fe5-4325-a01e-5be05399ef63",
"label": "noti_2",
"entries": [
{
"type": "Display",
"agent": "e32adcfd-0a01-47e1-8187-b9ee0055dc01",
"severity": "Critical"
},
{
"type": "Display",
"agent": "e32adcfd-0a01-47e1-8187-b9ee0055dc02",
"severity": "Major"
},
{
"type": "Display",
"agent": "e32adcfd-0a01-47e1-8187-b9ee0055dc03",
"severity": "Minor"
},
{
"type": "Display",
"agent": "e32adcfd-0a01-47e1-8187-b9ee0055dc04",
"severity": "Warning"
},
{
"type": "Display",
"agent": "e32adcfd-0a01-47e1-8187-b9ee0055dc03",
"severity": "Notice"
},
{
"type": "SNMP",
"agent": "aac5c67e-cbae-432a-a7c7-279a521bba10",
"severity": "Major"
},
{
"type": "EMAIL",
"agent": "aac5c67e-cbae-432a-a7c7-279a521bba12",
"severity": "Warning"
},
{
"type": "SYSLOG",
"agent": "aac5c67e-cbae-432a-a7c7-279a521bba11",
"severity": "Warning"
}
],
"modified": "2021-07-07T07:36:16.617Z",
"created": "2021-07-07T07:36:16.617Z"
},
{
"uuid": "f3a31bc3-e53f-4b63-9605-cd0b6121e603",
"label": "System Events",
"entries": [],
"modified": "2021-07-04T07:46:08.869Z",
"created": "2021-07-04T07:46:08.869Z"
}
],
"metadata": {
"item_count": 3,
"total_items": 3,
"current_page": 1,
"sort_by": [
{
"field": "label",
"direction": "ASC"
}
],
"links": {
"current": "http://192.168.0.22/api/5.0/notifications/config"
}
}
}
GET notifications/config/{uuid}
Resource Information
Requires Authentication? | |
Response Formats | json |
HTTP Methods | GET |
Returns an extended single Notification configuration view, specified by the required {uuid} parameter.
Resource URL
https://{{ip_address}}:{{port}}/api/{{version}}/notifications/config/{{uuid}}
Parameters
Parameter | Data Type | Description |
|---|---|---|
uuid | string | The UUID of the desired notofications. |
Example Request
GET
{
"data": [
{
"uuid": "d1469056-5fe5-4325-a01e-5be05399ef63",
"label": "noti_2",
"created": "2021-07-07T07:36:16.617Z",
"modified": "2021-07-07T07:36:16.617Z",
"entries": [
{
"severity": "Critical",
"type": "Display",
"agent": "e32adcfd-0a01-47e1-8187-b9ee0055dc01"
},
{
"severity": "Major",
"type": "Display",
"agent": "e32adcfd-0a01-47e1-8187-b9ee0055dc02"
},
{
"severity": "Minor",
"type": "Display",
"agent": "e32adcfd-0a01-47e1-8187-b9ee0055dc03"
},
{
"severity": "Warning",
"type": "Display",
"agent": "e32adcfd-0a01-47e1-8187-b9ee0055dc04"
},
{
"severity": "Notice",
"type": "Display",
"agent": "e32adcfd-0a01-47e1-8187-b9ee0055dc03"
},
{
"severity": "Major",
"type": "SNMP",
"agent": "aac5c67e-cbae-432a-a7c7-279a521bba10"
},
{
"severity": "Warning",
"type": "EMAIL",
"agent": "aac5c67e-cbae-432a-a7c7-279a521bba12"
},
{
"severity": "Warning",
"type": "SYSLOG",
"agent": "aac5c67e-cbae-432a-a7c7-279a521bba11"
}
]
}
],
"metadata": {}
}
GET notifications/config/meta
Resource Information
Requires Authentication? | |
Response Formats | json |
HTTP Methods | GET |
Returns all meta data used by Notifications configuration.
Resource URL
https://{{ip_address}}:{{port}}/api/{{version}}/notifications/config/meta
Example Request
GET
{
"Severities": [
"Critical",
"Major",
"Minor",
"Warning",
"Notice",
"Info",
"Keep Alive"
],
"Types": [
"SNMP",
"SYSLOG",
"Display",
"EMAIL",
"CED",
"Audio",
"Recording",
"Redis"
]
}
DELETE notifications/config/{uuid}
Resource Information
Requires Authentication? | |
Response Formats | json |
HTTP Methods | DELETE |
Delete a specific Notifications configuration.
Resource URL
https://{{ip_address}}:{{port}}/api/{{version}}/notifications/config/{{uuid}}
Parameters
Parameter | Data Type | Description |
|---|---|---|
uuid | string | The UUID of the notifications to be deleted. |
Example Request
DELETE
{
"data": [
{
"success": true
}
],
"metadata": {}
}
PUT notifications/config/{uuid}
Resource Information
Requires Authentication? | |
Response Formats | json |
HTTP Methods | PUT |
Edit a Notifications configuration.
Resource URL
https://{{ip_address}}:{{port}}/api/{{version}}/notifications/config/{{uuid}}
Parameters
Parameter | Data Type | Description |
|---|---|---|
uuid | string | The UUID of the notifications to be edited. |
Example Request
PUT
Body
{
"label": "Test II",
"entries": [
{
"severity": "Critical",
"type": "Display",
"agent": "e32adcfd-0a01-47e1-8187-b9ee0055dc01"
},
{
"severity": "Major",
"type": "Display",
"agent": "e32adcfd-0a01-47e1-8187-b9ee0055dc02"
},
{
"severity": "Minor",
"type": "Display",
"agent": "e32adcfd-0a01-47e1-8187-b9ee0055dc03"
},
{
"severity": "Warning",
"type": "Display",
"agent": "e32adcfd-0a01-47e1-8187-b9ee0055dc04"
}
]
}
Response
{
"data": [
{
"uuid": "ac5c4c87-51d6-48dd-a969-fceb46d5f702",
"label": "Test II",
"created": "2021-09-21T06:27:54.845Z",
"modified": "2021-09-21T06:29:24.816Z",
"entries": [
{
"severity": "Critical",
"type": "Display",
"agent": "e32adcfd-0a01-47e1-8187-b9ee0055dc01"
},
{
"severity": "Major",
"type": "Display",
"agent": "e32adcfd-0a01-47e1-8187-b9ee0055dc02"
},
{
"severity": "Minor",
"type": "Display",
"agent": "e32adcfd-0a01-47e1-8187-b9ee0055dc03"
},
{
"severity": "Warning",
"type": "Display",
"agent": "e32adcfd-0a01-47e1-8187-b9ee0055dc04"
}
]
}
],
"metadata": {}
}
POST notifications/config
Resource Information
Requires Authentication? | |
Response Formats | json |
HTTP Methods | POST |
Add a new Notifications, configured according to the attached data request.
Resource URL
https://{{ip_address}}:{{port}}/api/{{version}}/notifications/config
Example Request
POST
Body
{
"label": "Test II",
"entries": [
{
"severity": "Critical",
"type": "Display",
"agent": "e32adcfd-0a01-47e1-8187-b9ee0055dc01"
},
{
"severity": "Major",
"type": "Display",
"agent": "e32adcfd-0a01-47e1-8187-b9ee0055dc02"
},
{
"severity": "Minor",
"type": "Display",
"agent": "e32adcfd-0a01-47e1-8187-b9ee0055dc03"
},
{
"severity": "Warning",
"type": "Display",
"agent": "e32adcfd-0a01-47e1-8187-b9ee0055dc04"
}
]
}
Response
{
"data": [
{
"uuid": "ac5c4c87-51d6-48dd-a969-fceb46d5f702",
"label": "Test II",
"created": "2021-09-21T06:27:54.845Z",
"modified": "2021-09-21T06:27:54.845Z",
"entries": [
{
"severity": "Critical",
"type": "Display",
"agent": "e32adcfd-0a01-47e1-8187-b9ee0055dc01"
},
{
"severity": "Major",
"type": "Display",
"agent": "e32adcfd-0a01-47e1-8187-b9ee0055dc02"
},
{
"severity": "Minor",
"type": "Display",
"agent": "e32adcfd-0a01-47e1-8187-b9ee0055dc03"
},
{
"severity": "Warning",
"type": "Display",
"agent": "e32adcfd-0a01-47e1-8187-b9ee0055dc04"
}
]
}
],
"metadata": {}
}
- No labels