Veeam Backup for AWS 9
REST API Reference
Related documents

VPC Configuration Backup Policy

The /vpc/policy collection represents all restore points of VPC configuration available to Veeam Backup for AWS.

Get VPC Configuration Backup Policy

The HTTP GET request to the /vpc/policy endpoint retrieves the VPC configuration backup policy settings.

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/vpc/policy
Request samples 
curl -i -X GET \
  https://helpcenter.veeam.com/api/v1/vpc/policy \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'x-api-version: 1.7-rev0'
Response samples
application/json
{
  • "modifiedBy": "string",
  • "modificationTime": "2019-08-24T14:15:22Z",
  • "sourceOptions": {
    },
  • "backupOptionsEnabled": true,
  • "backupOptions": {
    },
  • "scheduleOptions": {
    },
  • "notificationOptions": {
    },
  • "protectedRegions": [
    ],
  • "_links": [
    ]
}

Modify VPC Configuration Backup Policy

The HTTP PUT request to the /vpc/policy endpoint updates the VPC configuration backup policy settings.

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
required
object (VpcPolicySourceSpecification)

Specifies settings for AWS Regions that must be protected by the policy.

backupOptionsEnabled
required
boolean

Defines whether Veeam Backup for AWS stores additional copies of VPC configuration backups on a backup repository.

required
object (VpcPolicySchedule)

Specifies schedule settings configured for the VPC configuration backup policy.

name
string

Specifies a name of the VPC configuration backup policy.

description
string

Specifies a description of the VPC configuration backup policy.

object (PolicyBackupSpecification)

Specifies a location where the backup files will be stored.

object (NotificationSettings)

Specifies retry and notification settings for the backup policy.

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

put/api/v1/vpc/policy
Request samples
application/json
{
  • "name": "string",
  • "description": "string",
  • "sourceOptions": {
    },
  • "backupOptionsEnabled": true,
  • "backupOptions": {
    },
  • "scheduleOptions": {
    },
  • "notificationOptions": {
    }
}
Response samples
application/json
{
  • "modifiedBy": "string",
  • "modificationTime": "2019-08-24T14:15:22Z",
  • "sourceOptions": {
    },
  • "backupOptionsEnabled": true,
  • "backupOptions": {
    },
  • "scheduleOptions": {
    },
  • "notificationOptions": {
    },
  • "protectedRegions": [
    ],
  • "_links": [
    ]
}

Start VPC Configuration Backup Policy

The HTTP POST request to the /vpc/policy/start endpoint launches the VPC configuration backup policy.

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
202

Accepted

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

post/api/v1/vpc/policy/start
Request samples 
curl -i -X POST \
  https://helpcenter.veeam.com/api/v1/vpc/policy/start \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'x-api-version: 1.7-rev0'
Response samples
application/json
{}

Stop VPC Configuration Backup Policy

The HTTP POST request to the /vpc/policy/stop endpoint stops execution of the VPC configuration backup policy.

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

post/api/v1/vpc/policy/stop
Request samples 
curl -i -X POST \
  https://helpcenter.veeam.com/api/v1/vpc/policy/stop \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'x-api-version: 1.7-rev0'
Response samples
application/json
{ }

Enable VPC Configuration Backup Policy

The HTTP POST request to the /vpc/policy/enable endpoint enables the VPC configuration backup policy.

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

post/api/v1/vpc/policy/enable
Request samples 
curl -i -X POST \
  https://helpcenter.veeam.com/api/v1/vpc/policy/enable \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'x-api-version: 1.7-rev0'
Response samples
application/json
{ }

Disable VPC Configuration Backup Policy

The HTTP POST request to the /vpc/policy/disable endpoint disables the VPC configuration backup policy.

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

post/api/v1/vpc/policy/disable
Request samples 
curl -i -X POST \
  https://helpcenter.veeam.com/api/v1/vpc/policy/disable \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'x-api-version: 1.7-rev0'
Response samples
application/json
{ }