Veeam Backup for AWS 9
REST API Reference
Related documents

Appliance System Info

The /system resource collection allows you to get Veeam Backup for AWS system logs and the current UTC date and time.

Get Managing Server

The HTTP GET request to the /system/properties endpoint retrieves information on a Veeam Backup & Replication server that manages the backup appliance.

NOTE
If the backup appliance is not managed by any Veeam Backup & Replication server, the request will return an empty response.

SecurityBearer
Request
header Parameters
x-api-version
required
string
Default: 1.7-rev0

Specifies the current version and revision of the Veeam Backup for AWS REST API.

Responses
200

OK

400

Bad Request. The request body is malformed, incomplete or otherwise invalid.

401

Unauthorized. The Authorization header does not contain an access token, or the provided access token is invalid.

403

Forbidden. The user sending a request does not have adequate privileges to access one or more objects specified in the request.

404

Not Found. One or more resources specified in the request could not be found in the specified resource collection.

500

Internal Server Error. The request has been received but could not be completed because of an internal error on the server side.

503

Service Unavailable

504

Gateway Timeout

get/api/v1/system/properties
Request samples 
curl -i -X GET \
  https://helpcenter.veeam.com/api/v1/system/properties \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'x-api-version: 1.7-rev0'
Response samples
{
  • "isManagedByBackupServer": true,
  • "backupServerHostName": "string"
}

Download Veeam Backup for AWS Logs

The HTTP GET request to the /system/logs endpoint generates the file with the system logs of Veeam Backup for AWS. Use the following query parameters to specify a time interval for which logs must be collected.

SecurityBearer
Request
query Parameters
ExportLogsType
string

Specifies an interval type used to collect the logs.

Enum: "LastDays" "BetweenDates"
Example: ExportLogsType=LastDays
Days
integer <int32>

[Applies to the LastDays interval type] Specifies a number of days for which to collect the logs.

Example: Days=7
FromDateUtc
string <date-time>

[Applies to the BetweenDates interval type] Specifies a date from which to collect the logs.

ToDateUtc
string <date-time>

[Applies to the BetweenDates interval type] Specifies a date up to which to collect the logs.

header Parameters
x-api-version
required
string
Default: 1.7-rev0

Specifies the current version and revision of the Veeam Backup for AWS REST API.

Responses
200

OK

400

Bad Request. The request body is malformed, incomplete or otherwise invalid.

401

Unauthorized. The Authorization header does not contain an access token, or the provided access token is invalid.

403

Forbidden. The user sending a request does not have adequate privileges to access one or more objects specified in the request.

404

Not Found. One or more resources specified in the request could not be found in the specified resource collection.

500

Internal Server Error. The request has been received but could not be completed because of an internal error on the server side.

503

Service Unavailable

504

Gateway Timeout

get/api/v1/system/logs
Request samples 
curl -i -X GET \
  'https://helpcenter.veeam.com/api/v1/system/logs?ExportLogsType=LastDays&Days=0&FromDateUtc=2019-08-24T14%3A15%3A22Z&ToDateUtc=2019-08-24T14%3A15%3A22Z' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'x-api-version: 1.7-rev0'
Response samples
No sample

Get System Date and Time

The HTTP GET request to the /system/time endpoint retrieves the current system (UTC) date and time.

SecurityBearer
Request
header Parameters
x-api-version
required
string
Default: 1.7-rev0

Specifies the current version and revision of the Veeam Backup for AWS REST API.

Responses
200

OK

400

Bad Request. The request body is malformed, incomplete or otherwise invalid.

401

Unauthorized. The Authorization header does not contain an access token, or the provided access token is invalid.

403

Forbidden. The user sending a request does not have adequate privileges to access one or more objects specified in the request.

404

Not Found. One or more resources specified in the request could not be found in the specified resource collection.

500

Internal Server Error. The request has been received but could not be completed because of an internal error on the server side.

503

Service Unavailable

504

Gateway Timeout

get/api/v1/system/time
Request samples 
curl -i -X GET \
  https://helpcenter.veeam.com/api/v1/system/time \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'x-api-version: 1.7-rev0'
Response samples
{
  • "utcDateTime": "2020-06-10T13:00:02.1112459"
}