Veeam Backup for AWS 9
REST API Reference
Related documents

License Agreements

The /licenseAgreement resource collection allows you to verify the acceptance of license agreements and to download the agreement to your device.

Get License Agreement

The HTTP GET request to the /api/v1/licenseAgreement endpoint retrieves license agreements and checksum parameters required for accepting terms of the agreements.

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.

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

Check Licence Agreement Acceptance

The HTTP GET request to the /licenseAgreement/accepted endpoint checks whether terms of the license agreements were accepted.

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.

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/licenseAgreement/accepted
Request samples 
curl -i -X GET \
  https://helpcenter.veeam.com/api/v1/licenseAgreement/accepted \
  -H 'x-api-version: 1.7-rev0'
Response samples
{
  • "accepted": true
}

Accept License Agreement

The HTTP POST request to the /licenseAgreement/accept endpoint accepts terms of the license agreements.

Request
query Parameters
eulaChecksum
required
string

Checksum for accepting terms of the Veeam license agreement.

thirdPartyLicenseAgreementChecksum
required
string

Checksum for accepting terms of the 3rd party components license agreements.

licensingPolicyChecksum
required
string

Checksum for accepting terms of the Veeam license policy.

requiredSoftwareChecksum
required
string

Checksum for accepting 3rd party software license agreements.

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.

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/licenseAgreement/accept
Request samples 
curl -i -X POST \
  'https://helpcenter.veeam.com/api/v1/licenseAgreement/accept?eulaChecksum=string&thirdPartyLicenseAgreementChecksum=string&licensingPolicyChecksum=string&requiredSoftwareChecksum=string' \
  -H 'x-api-version: 1.7-rev0'
Response samples
{
  • "type": "http://example.com",
  • "title": "string",
  • "status": 400,
  • "errorCode": "AccessDenied",
  • "details": "string",
  • "instance": "http://example.com",
  • "data": {
    }
}

Download License Agreement

The HTTP GET request to the /licenseAgreement/download endpoint allows you to download terms of the license agreements to your device.

Request
query Parameters
licenseAgreementType
required
string

Type of the license agreement that you want to download.

Enum: "Eula" "ThirdPartyAgreement" "LicensingPolicy" "RequiredSoftware"
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.

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/licenseAgreement/download
Request samples 
curl -i -X GET \
  'https://helpcenter.veeam.com/api/v1/licenseAgreement/download?licenseAgreementType=Eula' \
  -H 'x-api-version: 1.7-rev0'
Response samples
No sample