This is an archive version of the document. To get the most up-to-date information, see the current version.Getting Summary Information
This section explains how to get summary information.
For more information, see the Overview Dashboard section of the Veeam Backup for Microsoft Azure User Guide.
Request
GET https://<hostname>/api/v1/statistics/summary |
Request Headers
The request header must contain an authorization token of the current session.
Request Parameters
None.
Request Body
None.
Response
The server returns the following response to the client.
Response Codes
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 HTTPS headers.
Header | Description |
Content-length | The length of the response body. |
Content-type | The media type and syntax of the response body message: application/json; charset=utf-8 |
Response Body
Property | Type | Description |
|---|---|---|
alarmsCount | integer | Shows the number of alarms. |
alarmsCountChangesTrend | string | Shows changes in alarms. |
instancesCount | integer | Shows the number of instances. |
instancesCountChangesTrend | string | Shows changes in instances. |
protectedInstancesCount | integer | Shows the number of protected instances. |
protectedInstancesCountChangesTrend | string | Shows changes in protected instances. |
policiesCount | integer | Shows the number of backup policies. |
policiesCountChangesTrend | string | Shows changes in backup policies. |
repositoriesCount | integer | Shows the number of backup repositories. |
repositoriesCountChangesTrend | string | Shows changes in backup repositories. |
Example
Request: GET https://abc.ukwest.cloudapp.azure.com/api/v1/statistics/summary
Request Header: Authorization: Bearer <Access-Token>
Response: 200 OK
Response Body: { "alarmsCount": 0, "alarmsCountChangesTrend": "Decreased", "instancesCount": 18, "instancesCountChangesTrend": "Increased", "protectedInstancesCount": 1, "protectedInstancesCountChangesTrend": "NotChanged", "policiesCount": 2, "policiesCountChangesTrend": "Increased", "repositoriesCount": 1, "repositoriesCountChangesTrend": "NotChanged" } |