Veeam Backup for AWS 9
REST API Reference
Related documents

Appliance Configuration Overview

The /overview resource collection represents an overview of the current configuration of the Veeam Backup for AWS appliance.

Get Overview

The HTTP GET request to the /overview/userStatus endpoint retrieves an overview of the Veeam Backup for AWS configuration.

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/overview/userStatus
Request samples 
curl -i -X GET \
  https://helpcenter.veeam.com/api/v1/overview/userStatus \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'x-api-version: 1.7-rev0'
Response samples
{
  • "connectionsCount": 4,
  • "repositoryCount": 2,
  • "policiesCount": 2,
  • "workerLocationsCount": 6,
  • "workerConfigsCount": 6
}

Get Bottlenecks Overview

The HTTP GET request to the /overview/bottlenecks endpoint retrieves information on possible backup bottlenecks.

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.

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/overview/bottlenecks
Request samples 
curl -i -X GET \
  https://helpcenter.veeam.com/api/v1/overview/bottlenecks \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'x-api-version: 1.7-rev0'
Response samples
{
  • "policySizeIsOptimal": true,
  • "policyRAMIsOptimal": true,
  • "cpuIsOptimal": true,
  • "systemDiskIsOptimal": true,
  • "problemPolicyName": "string",
  • "problemRegion": "string",
  • "problemRegionLastUpdateDate": "2019-08-24T14:15:22Z",
  • "problemPolicyLastUpdateDate": "2019-08-24T14:15:22Z",
  • "systemDiskLastUpdateDate": "2019-08-24T14:15:22Z"
}