This operation returns a list of alerts for a laptop plan.
Request
Syntax
GET <webservice>/Plan/{planId}/Alerts HTTP/1.1
Host: <host name>
Accept: {application/xml | application/json}
Authtoken: <authentication token>where <webservice> is the root path used to route the API requests to the Web Server.
For more information, see Available Web Services for REST API.
Request Parameter
Name | Description | Required |
|---|---|---|
planId | The plan ID for the plan. If the plan ID is not known, use the GET Plan API to retrieve it. | Yes |
Request Headers
Name | Description |
|---|---|
Host | The host name of the Web Server or Web Console used in the API request. |
Accept | The format of the response. Valid values are: application/xml or application/json. |
Authtoken | The authentication token received after successfully logging on. For details on receiving an authentication token, see Authentication. |
Response
Response Parameters
Parameter | Description | Element |
|---|---|---|
alertName | The name of the alert on the plan. | alerts |
alertId | The system-generated ID assigned to the alert on the plan. | alerts |
Examples
Sample Request
GET <webservice>/Plan/10/Alerts HTTP/1.1
Host: client.mydomain.com
Accept: application/json
Authtoken: QSDK 38568012f4d1e8ee1841d283a47aa3ba78e124ea58354b5fc6
0f4dab8a63347d05cf5552484dafda3bfa4c5db84e580b1cb37bcf8e65b39f7f
8549a443e6f78a2c7be3f31b3d845e24776c835e498e8e883bb40c46bd15af4f
40ca94e823acedcdd4e9659e74b34a07a85c4586cd2ed914b6dce015874783ef7
68fda78183a4208930954a377f66eb56c8b92cexampl4s437a19317ca6ce7f323
3d5a01aca35dbad93468b833f2cf71010809006a937670adce711ca8be46638e8Sample Response
{ "alerts": [{ "alertName": "No backup for last 4 days", "alertId": 7 }, { "alertName": "Restore Job failed", "alertId": 8 }, { "alertName": "Edge drive quota alert", "alertId": 9 }, { "alertName": "Edge drive/share operations alert", "alertId": 14 }]
}