Get All Notification Rules

Get All Notification Rules

Get all the Notification Rules defined in the system

Request
URI
GET
https://{api_host}/suite-api/api/notifications/rules
COPY
Query Parameters
integer
page
Optional
Constraints: default: 0

Page number from which data needs to be displayed (0-based)

integer
pageSize
Optional
Constraints: default: 1000

Expected number of entries per page

Authentication
This operation uses the following authentication methods.
Responses
200

All the Notification Rules defined in the system

Returns notification-rules of type(s) application/json 
"{\n  \"rules\" : [ {\n    \"id\" : \"96225586-50a6-441d-9abf-c263f9c12b4b\",\n    \"name\" : \"Notification Rule 1\",\n    \"pluginId\" : \"Some Notification Plugin Instance ID\",\n    \"enabled\" : true,\n    \"templateId\" : \"Some Payload Template ID\",\n    \"alertControlStates\" : [ \"OPEN\", \"ASSIGNED\" ],\n    \"alertStatuses\" : [ \"NEW\", \"ACTIVE\" ],\n    \"criticalities\" : [ \"IMMEDIATE\", \"CRITICAL\" ],\n    \"resourceKindFilter\" : {\n      \"resourceKind\" : \"Datastore\",\n      \"adapterKind\" : \"VMWARE\"\n    },\n    \"resourceKindFilters\" : [ ],\n    \"resourceFilters\" : [ ],\n    \"alertTypeFilters\" : [ ],\n    \"alertDefinitionIdFilters\" : {\n      \"values\" : [ \"VMWARE-Datastore-NotEnoughIOPS\" ]\n    },\n    \"sendHeartbeat\" : false,\n    \"properties\" : [ ],\n    \"ruleType\" : \"ALERT\",\n    \"actionStatuses\" : [ ]\n  }, {\n    \"id\" : \"231efd3f-0201-483f-8c08-e9f34ba29e34\",\n    \"name\" : \"Notification Rule 2\",\n    \"pluginId\" : \"Some Other Notification Plugin Instance ID\",\n    \"enabled\" : false,\n    \"templateId\" : \"Some Other Payload Template ID\",\n    \"alertControlStates\" : [ \"SUPPRESSED\", \"SUSPENDED\" ],\n    \"alertStatuses\" : [ \"UPDATED\", \"CANCELED\" ],\n    \"criticalities\" : [ \"INFORMATION\", \"WARNING\" ],\n    \"resourceKindFilters\" : [ ],\n    \"resourceFilters\" : [ {\n      \"resourceId\" : \"555bc220-b9ff-47db-8353-d4e8ef4ecdf9\",\n      \"childrenResourceKindFilters\" : [ ],\n      \"childrenResourceKindKeyFilters\" : [ ]\n    } ],\n    \"alertTypeFilters\" : [ ],\n    \"alertImpactFilters\" : {\n      \"values\" : [ \"HEALTH\", \"RISK\" ]\n    },\n    \"sendHeartbeat\" : true,\n    \"properties\" : [ ],\n    \"ruleType\" : \"ALERT\",\n    \"actionStatuses\" : [ ]\n  } ]\n}"
object
pageInfo
Optional

Represents page information for a paged result

array of object
links
Optional

Collection of links

array of object
rules
Optional

List of Notification Rules


Code Samples
COPY
                    curl -H 'Authorization: <value>' https://{api_host}/suite-api/api/notifications/rules
On This Page
Notifications Operations
GET
Get Notification Templates
PUT
Update Notification Template
POST
Create Notification Template
GET
Get All Notification Rules
PUT
Update Notification Plugin Rule
POST
Create Notification Plugin Rule
GET
Get Notification Template
DELETE
Delete Notification Template
GET
Get Notification Rule
DELETE
Delete Notification Plugin Rules