Get Alert Using GET

Get Alert Using GET

Example: GET /api/alerts/{id}

Request
URI
GET
https://{api_host}/api/alerts/{id}
COPY
Path Parameters
string
id
Required

UUID of the alert


Authentication
This operation uses the following authentication methods.
Responses
200

The Alert for the specified identifier

Returns alert of type(s) application/json
{
    "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
}
string
alertDefinitionId
Optional

The identifier of the Alert Definition that defined this Alert

string
alertDefinitionName
Optional

Localized name of the associated Alert Definition

string As uuid As uuid
alertId
Optional

The UUID of the Alert

string
alertImpact
Optional

The impact of the Alert

string
alertLevel
Optional

The criticality of the alert

Possible values are : UNKNOWN, NONE, INFORMATION, WARNING, IMMEDIATE, CRITICAL, AUTO,
integer As int64 As int64
cancelTimeUTC
Optional

The UTC time when the Alert was cancelled

string
controlState
Optional

The state of the Alert

Possible values are : OPEN, ASSIGNED, SUSPENDED, SUPPRESSED,
extension
Optional

extension

array of link
links
Optional

links

string
ownerId
Optional

The unique ID for the user account that owns this Alert

string
ownerName
Optional

The user-name of the user account that owns this Alert

string As uuid As uuid
resourceId
Optional

The UUID of the Resource causing the Alert

integer As int64 As int64
startTimeUTC
Optional

The UTC time when the Alert started

string
statKey
Optional

The stat-key related to the violating alert. The alert may be associated with a stat-key and not have an associated alertDefinitionId if the alert was generated through an external event.

string
status
Optional

The status of the Alert

Possible values are : NEW, ACTIVE, UPDATED, CANCELED,
string
subType
Optional

The Sub-type of the Alert

integer As int64 As int64
suspendUntilTimeUTC
Optional

The UTC time when the suspended Alert will resume

string
type
Optional

The Alert Type describing the Alert

integer As int64 As int64
updateTimeUTC
Optional

The UTC time when the Alert was updated


404

No Alert with the specified identifier is found

Operation doesn't return any data structure

500

Error occurred while retrieving the Alert with the specified identifier

Operation doesn't return any data structure