Versions Compared

Old Version 4

changes.mady.by.user Ramya Raman

Saved on

compared with

New Version Current

changes.mady.by.user Ramya Raman

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

GET notifications/config

Resource Information

Requires Authentication?

Yes

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 

  1. https://192.168.0.22/api/5.0/notifications/config

Code Block
languagejson
{ "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" }, {

GET notifications/config

Resource Information

Requires Authentication?

Yes

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 

  1. https://192.168.0.22/api/5.0/notifications/config

Code Block
languagejson
{
    "data": [
        {
            "typeuuid": "Displayf3a31bc3-e53f-4b63-9605-cd0b6121e602",
                    "agent"label": "e32adcfd-0a01-47e1-8187-b9ee0055dc02Default",
                    "severity"entries": "Major"
[
               },                 {
                    "type": "Display",
                    "agent": "e32adcfd-0a01-47e1-8187-b9ee0055dc03b9ee0055dc01",
                    "severity": "MinorCritical"
                },
                {
                    "type": "Display",
                    "agent": "e32adcfd-0a01-47e1-8187-b9ee0055dc04b9ee0055dc02",
                    "severity": "WarningMajor"
                },
                {
                    "type": "Display",
                    "agent": "e32adcfd-0a01-47e1-8187-b9ee0055dc03",
                    "severity": "NoticeMinor"
                },
                {
                    "type": "SNMPDisplay",
                    "agent": "aac5c67ee32adcfd-cbae0a01-432a47e1-a7c78187-279a521bba10b9ee0055dc04",
                    "severity": "MajorWarning"
                },
                {
                    "type": "EMAILAudio",
                    "agent": "aac5c67e7d6b7ef6-cbae4a5d-432a427b-a7c78389-279a521bba1275d600a30098",
                    "severity": "WarningCritical"
                },
             ],
  {                     "type"modified": "SYSLOG2021-08-01T13:24:44.662Z",
            "created": "2021-07-04T07:46:08.869Z"
       "agent },
        {
            "uuid": "aac5c67ed1469056-cbae5fe5-432a4325-a7c7a01e-279a521bba115be05399ef63",
            "label": "noti_2",
      "severity": "Warning"     "entries": [
          }      {
       ],             "modifiedtype": "2021-07-07T07:36:16.617ZDisplay",
             "created": "2021-07-07T07:36:16.617Z"         }"agent": "e32adcfd-0a01-47e1-8187-b9ee0055dc01",
        {             "uuidseverity": "f3a31bc3-e53f-4b63-9605-cd0b6121e603",
Critical"
           "label": "System Events",   },
         "entries": [],      {
      "modified": "2021-07-04T07:46:08.869Z",             "createdtype": "2021-07-04T07:46:08.869Z"Display",
         }     ],      "metadataagent": { "e32adcfd-0a01-47e1-8187-b9ee0055dc02",
          "item_count": 3,         "total_itemsseverity": 3,"Major"
         "current_page": 1,      },
  "sort_by": [             {
                    "fieldtype": "labelDisplay",
                    "directionagent": "ASC"e32adcfd-0a01-47e1-8187-b9ee0055dc03",
            }         ],"severity": "Minor"
          "links": {     },
       "current": "http://192.168.0.22/api/5.0/notifications/config"         {
                    "type": "Display",
               }     }
}

GET notifications/config/{uuid}

Resource Information

Requires Authentication?

Yes

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
(required)

string

The UUID of the desired notifications.

Example Request

GET 

  1. https://192.168.0.22/api/5.0/notifications/config/d1469056-5fe5-4325-a01e-5be05399ef63

Code Block
languagejson
{
    "data": ["agent": "e32adcfd-0a01-47e1-8187-b9ee0055dc04",
                    "severity": "Warning"
                },
                {
             {             "uuid""type": "d1469056-5fe5-4325-a01e-5be05399ef63Display",
            "label": "noti_2",
            "createdagent": "2021-07-07T07:36:16.617Z",e32adcfd-0a01-47e1-8187-b9ee0055dc03",
              "modified      "severity": "2021-07-07T07:36:16.617Z",Notice"
               "entries": [ },
                {
                    "severitytype": "CriticalSNMP",
                    "typeagent": "Displayaac5c67e-cbae-432a-a7c7-279a521bba10",
                    "agentseverity": "e32adcfd-0a01-47e1-8187-b9ee0055dc01Major"
                },
                {
                    "severitytype": "MajorEMAIL",
                    "typeagent": "Displayaac5c67e-cbae-432a-a7c7-279a521bba12",
                    "agentseverity": "e32adcfd-0a01-47e1-8187-b9ee0055dc02Warning"
                },
                {
                    "severitytype": "MinorSYSLOG",
                    "typeagent": "Displayaac5c67e-cbae-432a-a7c7-279a521bba11",
                    "agentseverity": "e32adcfd-0a01-47e1-8187-b9ee0055dc03Warning"
                },
            ],
   {                     "severity"modified": "Warning2021-07-07T07:36:16.617Z",
            "created": "2021-07-07T07:36:16.617Z"
       "type": "Display" },
        {
            "agentuuid": "e32adcfdf3a31bc3-0a01e53f-47e14b63-81879605-b9ee0055dc04cd0b6121e603",
            "label": "System Events",
  },          "entries": [],
     {       "modified": "2021-07-04T07:46:08.869Z",
            "severitycreated": "Notice",2021-07-04T07:46:08.869Z"
        }
      ],
    "typemetadata": "Display",{
        "item_count": 3,
          "agenttotal_items": "e32adcfd-0a01-47e1-8187-b9ee0055dc03"3,
        "current_page": 1,
      },  "sort_by": [
             {
   
                "severityfield": "Majorlabel",
 
                  "typedirection": "SNMPASC",
            }
       "agent": "aac5c67e-cbae-432a-a7c7-279a521bba10" ],
        "links": {
      },                 {
                    "severity": "Warning","current": "http://192.168.0.22/api/5.0/notifications/config"
        }
            "type": "EMAIL",
                    "agent": "aac5c67e-cbae-432a-a7c7-279a521bba12"
                },
                {
      }
}

GET notifications/config/{uuid}

Resource Information

Requires Authentication?

Yes

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
(required)

string

The UUID of the desired notifications.

Example Request

GET 

  1. https://192.168.0.22/api/5.0/notifications/config/d1469056-5fe5-4325-a01e-5be05399ef63

Code Block
languagejson
{
    "data": [
        {
    "severity": "Warning",       "uuid": "d1469056-5fe5-4325-a01e-5be05399ef63",
            "typelabel": "SYSLOGnoti_2",
            "created": "2021-07-07T07:36:16.617Z",
            "agentmodified": "aac5c67e2021-cbae-432a-a7c7-279a521bba11"07-07T07:36:16.617Z",
            "entries": [
   }             ]{
          }     ],     "metadataseverity": {}
}

GET notifications/config/meta

Resource Information

Requires Authentication?

Yes

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 

  1. https://192.168.0.22/api/5.0/notifications/config/meta

Code Block
languagejson
{
    "Severities": ["Critical",
                    "type": "Display",
                    "agent": "e32adcfd-0a01-47e1-8187-b9ee0055dc01"
              "Critical",  },
      "Major",         "Minor", {
       "Warning",         "Notice",         "Info"severity": "Major",
        "Keep Alive"     ],      "Typestype": [ "Display",
                    "agent": "Display",e32adcfd-0a01-47e1-8187-b9ee0055dc02"
                },
                {
  "SNMP",         "EMAIL",         "SYSLOG"severity": "Minor",
        "Audio",            "Recording""type": "Display",
      ]
}

DELETE notifications/config/{uuid}

Resource Information

Requires Authentication?

Yes

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
(required)

string

The UUID of the notifications to be deleted.

Example Request

DELETE 

  1. https://192.168.0.22/api/5.0/notifications/config/d1469056-5fe5-4325-a01e-5be05399ef63

Code Block
languagejson
{
    "data": [
                "agent": "e32adcfd-0a01-47e1-8187-b9ee0055dc03"
                },
                {
     {             "success  "severity": true "Warning",
               }     ],"type": "Display",
      "metadata": {}
}

 

PUT notifications/config/{uuid}

Resource Information

Requires Authentication?

Yes

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
(required)

string

The UUID of the notifications to be edited.

Example Request

PUT 

  1. https://192.168.0.22/api/5.0/notifications/config/ac5c4c87-51d6-48dd-a969-fceb46d5f702

Body

Code Block
languagejson
{
    "label": "Test II",
    "entries": [
        {              "agent": "e32adcfd-0a01-47e1-8187-b9ee0055dc04"
                },
                {
                    "severity": "Notice",
                    "type": "Display",
                        "severityagent": "Critical",e32adcfd-0a01-47e1-8187-b9ee0055dc03"
            "type": "Display",      },
      "agent": "e32adcfd-0a01-47e1-8187-b9ee0055dc01"         }, {
       {             "severity": "Major",
                    "type": "DisplaySNMP",
                    "agent": "e32adcfdaac5c67e-0a01cbae-47e1432a-8187a7c7-b9ee0055dc02279a521bba10"
          },      },
  {             " {
                    "severity": "MinorWarning",
                    "type": "DisplayEMAIL",
                    "agent": "e32adcfdaac5c67e-0a01cbae-47e1432a-8187a7c7-b9ee0055dc03279a521bba12"
                },
          {      {
      "severity": "Warning",             "typeseverity": "DisplayWarning",
              "agent      "type": "e32adcfd-0a01-47e1-8187-b9ee0055dc04"SYSLOG",
         }     ] }

Response

Code Block
languagejson
{     "dataagent": [
        {
            "uuid": "ac5c4c87-51d6-48dd-a969-fceb46d5f702","aac5c67e-cbae-432a-a7c7-279a521bba11"
             "label": "Test II", }
           "created": "2021-09-21T06:27:54.845Z", ]
        }
   "modified": "2021-09-21T06:29:24.816Z" ],
            "entries": [
                {
                    "severity": "Critical",
    "metadata": {}
}

GET notifications/config/meta

Resource Information

Requires Authentication?

Yes

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 

  1. https://192.168.0.22/api/5.0/notifications/config/meta

Code Block
languagejson
{
    "Severities": [
        "Critical",
       "type": "DisplayMajor",
        "Minor",
        "Warning",
        "agentNotice": "e32adcfd-0a01-47e1-8187-b9ee0055dc01",
                   }"Info",
        "Keep Alive"
    ],
 {   "Types": [
        "Display",
       "severity": "MajorSNMP",
           "EMAIL",
        "typeSYSLOG": "Display",
          "Audio",
         "agentRecording":
"e32adcfd-0a01-47e1-8187-b9ee0055dc02"                 },
                {
                    "severity": "Minor",
             ]
}

DELETE notifications/config/{uuid}

Resource Information

Requires Authentication?

Yes

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
(required)

string

The UUID of the notifications to be deleted.

Example Request

DELETE 

  1. https://192.168.0.22/api/5.0/notifications/config/d1469056-5fe5-4325-a01e-5be05399ef63

Code Block
languagejson
{
    "data": [
      "type": "Display", {
                   "agent"success": "e32adcfd-0a01-47e1-8187-b9ee0055dc03"true
                },
                {
                    "severity": "Warning",
 ],
                  "type"metadata": "Display",
                    "agent": "e32adcfd-0a01-47e1-8187-b9ee0055dc04"
                }
            ]
        }
    ],
    "metadata": {}
}
POST notifications/config
{}
}

 

PUT notifications/config/{uuid}

Resource Information

Requires Authentication?

Yes

Response Formats

json

HTTP Methods

POST

PUT

Add Edit a new Notifications, configured according to the attached data requestNotifications configuration.

Resource URL

https://{{ip_address}}:{{port}}/api/{{version}}/notifications/config/{{uuid}}

Parameters

Parameter

Data Type

Description

uuid
(required)

string

The UUID of the notifications to be edited.

Example Request

POSTPUT 

  1. https://192.168.0.22/api/5.0/notifications/config/ac5c4c87-51d6-48dd-a969-fceb46d5f702

Body

Code Block
languagejson
{
    "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

Code Block
languagejson
{
    "data": [
        {
            "uuid": "ac5c4c87-51d6-48dd-a969-fceb46d5f702",
            "label": "Test II",
            "created": "2021-09-21T06:27:54.845Z",
            "modified": "2021-09-21T06:2729:5424.845Z816Z",
            "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?

Yes

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 

  1. https://192.168.0.22/api/5.0/notifications/config

Body

Code Block
languagejson
{
    "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

Code Block
languagejson
{
    "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": {}
}

POST notifications/config multi

Resource Information

Requires Authentication?

Yes

Response Formats

json

HTTP Methods

POST

Add multiple Notifications, configured according to the attached data request.

Resource URL

https://{{ip_address}}:{{port}}/api/{{version}}/notifications/config

Example Request

POST 

  1. https://192.168.0.22/api/5.0/notifications/config

Body

Code Block
languagejson
{
    "data": [
        {
    "label": "multi_Test_Noti1",
    "entries": [
        {
            "severity": "Critical",
            "type": "Display",
            "agent": "e32adcfd-0a01-47e1-8187-b9ee0055dc01"
        }
    ]
},
 {
    "label": "multi_Test_Noti2",
    "entries": [
        {
            "severity": "Minor",
            "type": "Display",
            "agent": "e32adcfd-0a01-47e1-8187-b9ee0055dc03"
        },
        {
            "severity": "Warning",
            "type": "Display",
            "agent": "e32adcfd-0a01-47e1-8187-b9ee0055dc04"
        }
    ]
}
    ]
}

Response

Code Block
languagejson
{
    "data": [
        {
            "uuid": "a470fc14-5f15-460d-8564-11af17d97023",
            "label": "multi_Test_Noti1",
            "created": "2022-02-23T11:24:05.948Z",
            "modified": "2022-02-23T11:24:05.948Z",
            "entries": [
                {
                    "severity": "Critical",
                    "type": "Display",
                    "agent": "e32adcfd-0a01-47e1-8187-b9ee0055dc01"
                }
            ]
        },
        {
            "uuid": "3286eb80-1ec6-48ef-ae35-5c835933303d",
            "label": "multi_Test_Noti2",
            "created": "2022-02-23T11:24:05.948Z",
            "modified": "2022-02-23T11:24:05.948Z",
            "entries": [
                {
                    "severity": "Minor",
                    "type": "Display",
                    "agent": "e32adcfd-0a01-47e1-8187-b9ee0055dc03"
                },
                {
                    "severity": "Warning",
                    "type": "Display",
                    "agent": "e32adcfd-0a01-47e1-8187-b9ee0055dc04"
                }
            ]
        }
    ],
    "metadata": {}
}

PUT notifications/config multi

Resource Information

Requires Authentication?

Yes

Response Formats

json

HTTP Methods

PUT

Edit multiple Notifications, configured according to the attached data request.

Resource URL

https://{{ip_address}}:{{port}}/api/{{version}}/notifications/config

Example Request

PUT 

  1. https://192.168.0.22/api/5.0/notifications/config

Body

Code Block
languagejson
{
    "data": [
        {
            "uuid": "a470fc14-5f15-460d-8564-11af17d97023",
            "label": "multi_Test_Noti1",
            "entries": [
                {
                    "severity": "Critical",
                    "type": "Display",
                    "agent": "e32adcfd-0a01-47e1-8187-b9ee0055dc01"
                }
            ]
        },
        {
            "uuid": "3286eb80-1ec6-48ef-ae35-5c835933303d",
            "label": "multi_Test_Noti2",
            "entries": [
                {
                    "severity": "Minor",
                    "type": "Display",
                    "agent": "e32adcfd-0a01-47e1-8187-b9ee0055dc03"
                },
                {
                    "severity": "Warning",
                    "type": "Display",
                    "agent": "e32adcfd-0a01-47e1-8187-b9ee0055dc04"
                }
            ]
        }
    ]
}

Response

Code Block
languagejson
{
    "data": [
        {
            "uuid": "a470fc14-5f15-460d-8564-11af17d97023",
            "label": "multi_Test_Noti1",
            "created": "2022-02-23T11:24:05.948Z",
            "modified": "2022-02-23T11:26:45.084Z",
            "entries": [
                {
                    "severity": "Critical",
                    "type": "Display",
                    "agent": "e32adcfd-0a01-47e1-8187-b9ee0055dc01"
                }
            ]
        },
        {
            "uuid": "3286eb80-1ec6-48ef-ae35-5c835933303d",
            "label": "multi_Test_Noti2",
            "created": "2022-02-23T11:24:05.948Z",
            "modified": "2022-02-23T11:26:45.084Z",
            "entries": [
                {
                    "severity": "Minor",
                    "type": "Display",
                    "agent": "e32adcfd-0a01-47e1-8187-b9ee0055dc03"
                },
                {
                    "severity": "Warning",
                    "type": "Display",
                    "agent": "e32adcfd-0a01-47e1-8187-b9ee0055dc04"
                }
            ]
        }
    ],
    "metadata": {}
}

DELETE notifications/config multi

Resource Information

Requires Authentication?

Yes

Response Formats

json

HTTP Methods

DELETE

Delete multiple Notifications configuration.

Resource URL

https://{{ip_address}}:{{port}}/api/{{version}}/notifications/config/{{uuid}}

Example Request

DELETE 

  1. https://192.168.0.22/api/5.0/notifications/config

Body

Code Block
languagejson
{
    "severitydata": "Warning",
       [
            "type": "Display",
 "a470fc14-5f15-460d-8564-11af17d97023",
                  "agent": "e32adcfd-0a01-47e1-8187-b9ee0055dc04"3286eb80-1ec6-48ef-ae35-5c835933303d"
                }]
}

Response

Code Block
languagejson
{
    "data": {
      ]  "success":  true
    }
    ],
    "metadata": {}
}