Get Alerts Using GET | VMware vRealize Operations API

Get Alerts Using GET

Example: GET /api/alerts?id={id1}&id={id2}&resourceId={resId1}&resourceId={resId2}

Request

URI

GET

https://{api_host}/api/alerts

COPY

Query Parameters

string of array

Optional

Identifiers of the Alerts

integer

page

Optional

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

integer

pageSize

Optional

Expected number of entries per page

string of array

resourceId

Optional

Identifiers of the Resources whose Alerts you need to be looked up

Authentication

This operation uses the following authentication methods.

vRealizeOpsToken

Responses

200

Alerts matching the specified identifiers. Can be empty

Returns alerts of type(s) application/json

{
    "alerts": [
        {
            "alertDefinitionId": "string",
            "alertDefinitionName": "string",
            "alertId": "string",
            "alertImpact": "string",
            "alertLevel": "string",
            "cancelTimeUTC": 0,
            "controlState": "string",
            "extension": {
                "anyObjects": [
                    {}
                ]
            },
            "links": [
                {
                    "description": "string",
                    "href": "string",
                    "name": "string",
                    "rel": "string"
                }
            ],
            "ownerId": "string",
            "ownerName": "string",
            "resourceId": "string",
            "startTimeUTC": 0,
            "statKey": "string",
            "status": "string",
            "subType": "string",
            "suspendUntilTimeUTC": 0,
            "type": "string",
            "updateTimeUTC": 0
        }
    ],
    "links": [
        {
            "description": "string",
            "href": "string",
            "name": "string",
            "rel": "string"
        }
    ],
    "pageInfo": {
        "page": 0,
        "pageSize": 0,
        "sortBy": "string",
        "sortOrder": "string",
        "totalCount": 0
    }
}

array of alert

alerts

Optional

List of alerts

array of link

links

Optional

Collection of links

page-info

pageInfo

Optional

Represents page information for a paged result