Get Rules Of Plugin Using GET

Retrieve all the notification rules of the plugin instance

Request

URI

GET

https://{api_host}/api/alertplugins/{pluginId}/rules

COPY

Path Parameters

string

pluginId

Required

The identifier for the plugin instance

Authentication

This operation uses the following authentication methods.

vRealizeOpsToken

Responses

200

List of notification rules

Returns notification-rules of type(s) application/json

{
    "links": [
        {
            "description": "string",
            "href": "string",
            "name": "string",
            "rel": "string"
        }
    ],
    "pageInfo": {
        "page": 0,
        "pageSize": 0,
        "sortBy": "string",
        "sortOrder": "string",
        "totalCount": 0
    },
    "rules": [
        {
            "alertControlStates": [
                "string"
            ],
            "alertDefinitionIdFilters": {
                "values": [
                    "string"
                ]
            },
            "alertImpactFilters": {
                "values": [
                    "string"
                ]
            },
            "alertStatuses": [
                "string"
            ],
            "alertTypeFilters": [
                {
                    "alertSubTypes": [
                        0
                    ],
                    "alertType": 0
                }
            ],
            "collectorGroupId": "string",
            "collectorUUId": "string",
            "criticalities": [
                "string"
            ],
            "id": "string",
            "links": [
                {
                    "description": "string",
                    "href": "string",
                    "name": "string",
                    "rel": "string"
                }
            ],
            "name": "string",
            "pluginId": "string",
            "properties": [
                {
                    "name": "string",
                    "value": "string"
                }
            ],
            "resourceFilter": {
                "childrenResourceKindFilters": [
                    "string"
                ],
                "childrenResourceKindKeyFilters": [
                    {
                        "adapterKind": "string",
                        "resourceKind": "string"
                    }
                ],
                "matchResourceIdOnly": false,
                "relationship": "string",
                "resourceId": "string"
            },
            "resourceFilters": [
                {
                    "childrenResourceKindFilters": [
                        "string"
                    ],
                    "childrenResourceKindKeyFilters": [
                        {
                            "adapterKind": "string",
                            "resourceKind": "string"
                        }
                    ],
                    "matchResourceIdOnly": false,
                    "relationship": "string",
                    "resourceId": "string"
                }
            ],
            "resourceKindFilter": {
                "adapterKind": "string",
                "resourceKind": "string"
            },
            "resourceKindFilters": [
                {
                    "adapterKind": "string",
                    "resourceKind": "string"
                }
            ],
            "templateId": "string"
        }
    ]
}

array of link

links

Optional

Collection of links

page-info

pageInfo

Optional

Represents page information for a paged result

array of notification-rule

rules

Optional

List of Notification Rules