Ir para o conteúdo principal
CloudStudio

Get an alert by its ID

This API allows retrieving an alert by its ID.

Request

GET /api/v2/alerts/{alertID} HTTP/1.1
Host: gear.cloud.studio
Authorization: Bearer {accessToken}

Parameters

NameDescription
accessTokenAccess token with permissions to read alert information. See this page for more information. The access token can also be sent as part of the query string, using the "accessToken" parameter.
alertIDUnique identifier of the alert for which information is requested.

Response

The response contains the specified alert, as shown in this example:

{
    "AlertID": 211,
    "VariableTypeID": 1,
    "EndpointID": 114092,
    "ConditionType": 3,
    "Threshold": 25,
    "ClientID": 4,
    "FacilityID": 184,
    "NormalConditionType": 6,
    "NormalThreshold": 24,
    "MinimumDurationSeconds": 300,
    "NotificationEmails": [
        "someone@somewhere.com"
    ],
    "NotificationSMSNumbers": [
        "+1123456789"
    ],
    "NotificationVoiceNumbers": [
        "+1123456789"
    ],
    "Tags": [
        "default",
        "gateway-default"
    ],
    "SequenceNumber": 45701485,
    "Enabled": true,
    "Schedules": [
        {
            "Days": [
                1,
                2,
                4,
                5
            ],
            "StartTime": {
                "Hour": 0,
                "Millisecond": 0,
                "Minute": 0,
                "Second": 0
            },
            "EndTime": {
                "Hour": 23,
                "Millisecond": 999,
                "Minute": 0,
                "Second": 59
            }
        }
    ],
    "Timezone": {
        "CurrentOffsetMinutes": -180,
        "TimeZoneCode": "america/argentina/buenos_aires"
    }
}

Última atualização em

Nesta página