Veeam Backup for AWS 9
REST API Reference
Related documents

Licensing

The /licensing resource collection represents Veeam Backup for AWS license information, license usage data and configured notifications on license usage and expiration.

Get License Details

The HTTP GET request to the /licensing/license endpoint retrieves nformation on the installed Veeam Backup for AWS license.

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

401

Unauthorized. The authorization header has been expected but not found (or found but is expired).

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/licensing/license
Request samples 
curl -i -X GET \
  https://helpcenter.veeam.com/api/v1/licensing/license \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'x-api-version: 1.7-rev0'
Response samples
{}

Install License

The HTTP POST request to the /licensing/license endpoint allows you to upload a license file obtained from Veeam.

NOTE
The information in this section applies only to the BYOL edition of Veeam Backup for AWS.

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.

Request Body schema: multipart/form-data
required
licenseFile
required
string <binary>

License file in the .lic format.

Responses
200

OK

401

Unauthorized. The authorization header has been expected but not found (or found but is expired).

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

post/api/v1/licensing/license
Request samples 
curl -i -X POST \
  https://helpcenter.veeam.com/api/v1/licensing/license \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: multipart/form-data' \
  -H 'x-api-version: 1.7-rev0' \
  -F licenseFile=string
Response samples
{
  • "licenseType": "Subscription",
  • "instancesUses": 0,
  • "instances": 100,
  • "licensedTo": "CompanyName",
  • "licenseExpires": "2021-11-10T08:40:48.305Z",
  • "licenseId": "OU7890",
  • "supportId": "9C75",
  • "_links": []
}

Remove License

The HTTP POST request to the /licensing/license endpoint removes the installed Veeam Backup for AWS license.

NOTE
The information in this section applies only to the BYOL edition of Veeam Backup for AWS.

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
204

No Content

401

Unauthorized. The authorization header has been expected but not found (or found but is expired).

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

delete/api/v1/licensing/license
Request samples 
curl -i -X DELETE \
  https://helpcenter.veeam.com/api/v1/licensing/license \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'x-api-version: 1.7-rev0'
Response samples
{ }

Export License Usage Report

The HTTP POST request to the /licensing/license/export endpoint exports the license usage report to a .CSV or an .XML file. To specify the required type of the file, use the Accept request header.

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

401

Unauthorized. The authorization header has been expected but not found (or found but is expired).

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

post/api/v1/licensing/license/export
Request samples 
curl -i -X POST \
  https://helpcenter.veeam.com/api/v1/licensing/license/export \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'x-api-version: 1.7-rev0'

Get Instances Consuming License Units

The HTTP GET request to the /licensing/licensedWorkloads endpoint retrieves a list of instances consuming license units.

SecurityBearer
Request
query Parameters
Offset
integer <int32> >= 0

Excludes from a response the first N items of a resource collection.

Limit
integer <int32> >= -1

Specifies the maximum number of items of a resource collection to return in a response.

Sort
Array of strings

Specifies the order of items in the response. For more information, see the Veeam Backup for AWS REST API Reference Overview, section Sort Parameter.

Items Enum: "nameAsc" "nameDesc" "lastBackupAsc" "lastBackupDesc"
SearchPattern
string

Returns only those items of a resource collection whose names match the specified search pattern in the parameter value.

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

401

Unauthorized. The authorization header has been expected but not found (or found but is expired).

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/licensing/licensedWorkloads
Request samples 
curl -i -X GET \
  'https://helpcenter.veeam.com/api/v1/licensing/licensedWorkloads?Offset=0&Limit=-1&Sort=nameAsc&SearchPattern=string' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'x-api-version: 1.7-rev0'
Response samples
{
  • "totalCount": 3,
  • "results": [
    ],
  • "_links": []
}

Get License Alerts

The HTTP GET request to the /licensing/alerts endpoint retrieves alerts on license usage and expiration time fired in Veeam Backup for AWS.

NOTE
To resolve alerts, send one of the suggested in the response available replies to the Veeam Backup for AWS appliance. For more information, see Resolve License Alerts.

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 has been expected but not found (or found but is expired).

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/licensing/alerts
Request samples 
curl -i -X GET \
  https://helpcenter.veeam.com/api/v1/licensing/alerts \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'x-api-version: 1.7-rev0'
Response samples
{
  • "results": [
    ],
  • "_links": []
}

Resolve License Alerts

The HTTP POST request to the /licensing/alerts/resolve endpoint allows you to resolve license alerts received from the Veeam Backup for AWS appliance.

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.

Request Body schema: application/json
required
notificationsToResolve
required
Array of strings (LicenseNotificationTypes)

Specifies types of alerts you want to resolve.

Items Enum: "Expiration" "Exceed" "Marketplace"
Array of objects (LicenseNotificationReply)

Specifies the reply for each alert type.

Responses
204

No Content

400

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

401

Unauthorized. The authorization header has been expected but not found (or found but is expired).

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

post/api/v1/licensing/alerts/resolve
Request samples
application/json
{
  • "notificationsToResolve": [
    ],
  • "selectedReplies": [
    ]
}
Response samples
{ }