This is an archive version of the document. To get the most up-to-date information, see the current version.Get License Alerts
You can get alerts on license usage and expiration time fired in Veeam Backup for AWS. Alerts are fired only for Paid and BYOL license types.
Note |
You can resolve only alerts for the Paid license type. To resolve alerts, send one of the suggested in the response available replies to the Veeam Backup for AWS server. For more information, see Resolve License Alerts. |
Request
To retrieve information on fired alerts, send the HTTP GET request to the /licensing/alerts endpoint.
HTTP Request
GET https://<hostname>:<port>/api/v1/licensing/alerts |
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. |
x-api-version | Required | 1.0-rev0 | Specifies the current revision of the Veeam Backup for AWS REST API. |
Accept | Optional |
| 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. |
Response
The server returns the following response to the client.
Response Code
A successfully completed operation returns a 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 | Value | Description |
|---|---|---|
Content-Length | integer | Identifies the length of the response body message, in bytes. |
Content-Type |
| Identifies the media type of the response body message. |
Response Body
In the response body, Veeam Backup for AWS returns all fired alerts and available replies to resolve the notifications. The LicenseNotification schema is used for the collection representation.
Example
The following request returns license alerts fired in Veeam Backup for AWS and possible replies used to resolve the alerts.
|