This is an archive version of the document. To get the most up-to-date information, see the current version.Get Alarm Status Changes
You can get all status changes of a triggered alarm with the specified template UID.
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 all status changes of a triggered alarm, send the GET HTTP request to the URL of the /alarms/templates/{alarmUid}/events collection.
HTTP Request
GET https://<hostname>:1280/api/v3/alarms/templates/{alarmUid}/events |
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 |
|---|---|---|---|---|---|
alarmUid | Path | String (uuid) | Yes | — | Alarm template UID |
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 
The following request returns a representation of all status changes of a triggered alarm.
Request: GET https://localhost:1280/api/v3/alarms/templates/23c18c21-9014-4951-9524-402d6c78ff3f/events
Request Header: Authorization: Bearer <Access-Token>
Response Code: 200 OK
Response Body: { "meta": { "pagingInfo": { "total": 1, "count": 1, "offset": 0 } }, "data": [ { "instanceUid": "ac3cf963-0dab-4d3a-8b46-dac5ac9f29ed", "alarmTemplateUid": "4bebdb54-05c2-4f52-b8a5-5cbff06b1eba", "repeatCount": 1, "object": { "instanceUid": "d5e78951-4580-40da-9e1a-1ae59b83b91b", "type": "objectEntity", "organizationUid": "1885437f-db1c-45fc-b4f1-2f54b506a353", "locationUid": "c94a8afd-d0ee-4c86-9af8-fbbd6c97b373", "managementAgentUid": "353c4010-6b74-428d-a8de-019761406f05", "computerName": "winsrv3", "objectName": "Workstation: File level backup. Personal files. Local drive. Daily schedule._winsrv3" }, "lastActivation": { "instanceUid": "41691c89-e04b-442b-8e57-1f9003e689f1", "time": "2020-03-28T04:30:07.1752853+03:00", "status": "error", "message": "Job session for \"Workstation: File level backup. Personal files. Local drive. Daily schedule._restv3vaw2\" finished with error. \nError: Operation was canceled by user WORKGROUP\\SYSTEM\r\n", "remark": "\r\n" } } ] } |