This is an archive version of the document. To get the most up-to-date information, see the current version.Resolve Triggered Alarm
You can resolve a triggered alarm 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 resolve a triggered alarm, send the POST HTTP request to the URL of the /alarms/active/{activeAlarmUid}/resolve resource. Additionally you must create a query string that contains a comment for resolved alarm and specify whether alarm must be resolved on a client portal.
HTTP Request
POST https://<hostname>:1280/api/v3/alarms/active/{activeAlarmUid}/resolve?comment=<comment>&resolveOnClients=true |
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 |
|---|---|---|---|---|---|
activeAlarmUid | Path | String (uuid) | Yes | — | Triggerd alarm UID |
comment | Query | String | Yes | — | Comment about resolving the alarm |
resolveOnClients | Query | Boolean | Yes | — | Indicates whether the alarm must be resolved on a client portal |
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 |
Example 
The following request creates a clone of an alarm template with UID fc3207ec-f630-42e5-969e-f032c3706fbb.
Request: POST https://localhost:1280/api/v3/alarms/active/fc3207ec-f630-42e5-969e-f032c3706fbb/resolve?comment=Fixed&resolveOnClients=true
Request Header: Content-type: application/json
Response Code: 200 OK |