Get All Triggered Alarms

You can get a collection resource representation of all triggered alarms.

Required Privileges

To perform this task, a user must have one of the following roles assigned: Portal Administrator, Service Provider Global Administrator, Service Provider Administrator, Company Owner, Company Administrator.

Request

To get a representation of all triggered alarms, send the GET HTTP request to the URL of the /alarms/active collection.

HTTP Request

GET https://<hostname>:1280/api/v3/alarms/active

Request Headers

The request contains the following headers.

Header

Required/Optional

Value

Description

Authorization

Required

Bearer <Access-Token>

Authenticates a client who sends the request to the server. Must contain the access token for the current logon session in the Bearer <Access-Token> format.

Accept

Optional

application/json

Specifies a media type of representation that is required in the response message. If the requested type is not supported, the server will return the response in the application/json media type.

Request parameters

A list of parameters that are applicable for this operation:

Name

In

Type

Required

Default

Description

limit

Query

Integer (int32)

No

100

Specifies the first N resources that must be returned in the output

offset

Query

Integer (int32)

No

0

Excludes the first N resources from the query output

Response

The server returns the following response to the client.

Response Code

A successfully completed operation returns response code 200 OK.

Response Headers

The response to this request contains the following headers. The response may also include additional standard HTTP headers.

Header

Description

Content-length

The length of the response body.

Content-type

The media type and syntax of the request body message: application/json; charset=utf-8

Response Body

In the response body, Veeam Service Provider Console returns a collection resource representation based on the ActiveAlarm schema.

Example Get All Triggered Alarms

The following request returns a representation of all triggered alarms.

Request:

GET https://localhost:1280/api/v3/alarms/active

 

Request Header:

Authorization: Bearer <Access-Token>

 

Response Code:

200 OK

 

Response Body:

{

 "meta": {

   "pagingInfo": {

     "total": 2,

     "count": 2,

     "offset": 0

   }

 },

 "data": [

   {

     "instanceUid": "82c6dd29-9b44-4afe-9f38-252cf67e8df0",

     "alarmTemplateUid": "0a86425e-db66-4425-1ae7-aabcaf962876",

     "repeatCount": 1,

     "object": {

       "instanceUid": "04f4ba78-17f7-47ab-8b06-44a018a9e3c8",

       "type": "internal",

       "organizationUid": "1b483cd8-24f0-4745-8248-e428e8f5c7c1",

       "locationUid": "00000000-0000-0000-0000-000000000000",

       "managementAgentUid": "00000000-0000-0000-0000-000000000000",

       "computerName": "srv02",

       "objectName": "srv02"

     },

     "lastActivation": {

       "instanceUid": "07269f0b-bd79-4c4a-ab94-a75e85abfcb4",

       "time": "2020-03-30T03:48:04.9882714+03:00",

       "status": "info",

       "message": "License auto-update functionality is not enabled.\r\n",

       "remark": "\r\n"

     }

   },

   {

     "instanceUid": "f57f4eda-fa33-4684-baa6-04c123a3899f",

     "alarmTemplateUid": "73a98986-3c17-4d74-ac94-da4ce119e3da",

     "repeatCount": 1,

     "object": {

       "instanceUid": "231c043f-80e9-4f1f-8cb2-1f562d4db801",

       "type": "objectEntity",

       "organizationUid": "eb2ab9ad-e340-466c-b042-780ec2cd2178",

       "locationUid": "6bbb8972-c709-4fc6-b6b0-b29f16587c67",

       "managementAgentUid": "c0a9c946-9fac-48d5-a978-f08a8e022ea9",

       "computerName": "winsrv9",

       "objectName": "autoCloudReplicaJob"

     },

     "lastActivation": {

       "instanceUid": "343f7a40-a437-4577-8d2f-12e987c1d3be",

       "time": "2020-03-28T04:04:05.4912697+03:00",

       "status": "warning",

       "message": "Job finished with warning.\nDetails:\nOne or more source networks were possibly mapped onto the same cloud network. Simultaneous partial failovers of VMs residing on those networks may result in issues: winsrv9_replica_job.\r\n",

       "remark": "\r\n"

     }

   }

 ]

}

I want to report a typo

There is a misspelling right here:

 

I want to let the Veeam Documentation Team know about that.