This is an archive version of the document. To get the most up-to-date information, see the current version.Statistics
You can get your Veeam Backup for AWS statistics for the current moment.
Request
To retrieve statistics of Veeam Backup for AWS, send the HTTP GET request to the /summary endpoint.
HTTP Request
GET https://<hostname>:<port>/api/v1/summary |
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 the following:
Property | Type | Description |
|---|---|---|
alarmsCount | integer | Number of alarms fired in Veeam Backup for AWS for the last 24 hours. |
alarmsCountChangesTrend | string | Defines whether the number of alarms has changed for the last 24 hours. Possible values: NotChanged, Increased, Decreased. |
instancesCount | integer | Number of EC2 instances you can protect by Veeam Backup for AWS. |
instancesCountChangesTrend | string | Defines whether the number of EC2 instances you can protect has changed for the last 24 hours. Possible values: NotChanged, Increased, Decreased. |
protectedInstancesCount | integer | Number of EC2 instances backed-up by Veeam Backup for AWS. |
protectedInstancesCountChangesTrend | string | Defines whether the number of backed-up EC2 instances has changed for the last 24 hours. Possible values: NotChanged, Increased, Decreased. |
policiesCount | integer | Number of backup policies created in Veeam Backup for AWS. |
policiesCountChangesTrend | string | Defines whether the number of backup policies has changed for the last 24 hours. Possible values: NotChanged, Increased, Decreased. |
repositoriesCount | integer | Number of S3 repositories added to Veeam Backup for AWS. |
repositoriesCountChangesTrend | string | Defines whether the number of S3 repositories has changed for the last 24 hours. Possible values: NotChanged, Increased, Decreased. |
Example
The following request returns statistics of Veeam Backup for AWS.
|