Get Alarm Template

You can get a resource representation of an alarm template with the specified 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 a resource representation of an alarm template, send the GET HTTP request to the URL of the /alarms/templates/{alarmUid} resource.

HTTP Request

GET https://<hostname>:1280/api/v3/alarms/templates/{alarmUid}

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

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 resource representation based on the Alarm schema.

Example Get Alarm Template

The following request returns a representation of an alarm template with UID 4db61eb7-134c-424e-b469-da4456223d4f.

Request:

GET https://localhost:1280/api/v3/alarms/templates/4db61eb7-134c-424e-b469-da4456223d4f

 

Request Header:

Authorization: Bearer <Access-Token>

 

Response Code:

200 OK

 

Response Body:

{

 "data": {

   "instanceUid": "4db61eb7-134c-424e-b469-da4456223d4f",

   "name": "Job state",

   "category": "backupVmJob",

   "organizationUid": "11483cd8-24f0-4745-8248-e420e8f5c7c1",

   "internalId": 1,

   "knowledge": {

     "summary": "Job is in a disabled state for more than an allowed time period.",

     "cause": "Veeam Backup & Replication server allows to disable scheduled jobs during maintenance windows. If a job stays in a disabled state for more than an allowed time period, it should be enabled back.",

     "resolution": "Open Veeam Backup & Replication console and enable all disabled jobs."

   },

   "isPredifined": true,

   "isEnabled": true

 }

}

I want to report a typo

There is a misspelling right here:

 

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