Get Alert Definitions Using GET

If the search criteria is not satisfied, the API will return all Alert Definitions

Request

URI

GET

https://{api_host}/api/alertdefinitions

COPY

Query Parameters

string

adapterKind

Optional

The Adapter Kind key of the Alert Definitions to search for

string of array

Optional

The identifier(s) of the Alert Definitions to search for. Do not specify adapterKind or resourceKind if searching by the identifier

integer

page

Optional

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

integer

pageSize

Optional

Expected number of entries per page

string

resourceKind

Optional

The Resource Kind key of the Alert Definitions to search for

Authentication

This operation uses the following authentication methods.

vRealizeOpsToken

Responses

200

The collection of Alert Definitions

Returns alert-definitions of type(s) application/json

{
    "alertDefinitions": [
        {
            "adapterKindKey": "string",
            "cancelCycles": 0,
            "description": "string",
            "id": "string",
            "name": "string",
            "resourceKindKey": "string",
            "states": [
                {
                    "impact": {
                        "detail": "string",
                        "impactType": "string"
                    },
                    "recommendationPriorityMap": {
                        "recommendationPriorityMap": 0
                    },
                    "severity": "string",
                    "symptoms": {}
                }
            ],
            "subType": 0,
            "type": 0,
            "waitCycles": 0
        }
    ],
    "links": [
        {
            "description": "string",
            "href": "string",
            "name": "string",
            "rel": "string"
        }
    ],
    "pageInfo": {
        "page": 0,
        "pageSize": 0,
        "sortBy": "string",
        "sortOrder": "string",
        "totalCount": 0
    }
}

array of alert-definition

alertDefinitions

Optional

Collection of Problem Definitions

array of link

links

Optional

Collection of links

page-info

pageInfo

Optional

Represents page information for a paged result