Veeam Backup for AWS 9
REST API Reference
Related documents

VPC Configuration Restore Points

The /vpc/restorePoints resource collection represents the VPC Configuration Backup policy.

Get VPC Configuration Restore Points

The HTTP GET request to the /vpc/restorePoints endpoint retrieves a list of VPC configuration restore points stored in the Veeam Backup for AWS database.

SecurityBearer
Request
query Parameters
Region
string

Returns only VPC configuration restore points of an AWS Region with the specified region name.

Example: Region=us-east-1
AwsAccountId
string

Returns restore points of VPC configurations that belong to an AWS account with the specified AWS ID.

AwsOrganizationId
string

Returns restore points of VPC configurations that belong to an AWS Organization with the specified AWS ID.

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 (VpcRestorePointsRequestOrderColumn)

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: "pointInTimeAsc" "pointInTimeDesc" "immutableTillUtcAsc" "immutableTillUtcDesc" "awsAccountIdAsc" "awsAccountIdDesc"
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/restorePoints
Request samples 
curl -i -X GET \
  'https://helpcenter.veeam.com/api/v1/vpc/restorePoints?Region=string&AwsAccountId=string&AwsOrganizationId=string&Offset=0&Limit=-1&Sort=pointInTimeAsc' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'x-api-version: 1.7-rev0'
Response samples
{
  • "totalCount": 0,
  • "data": [
    ],
  • "_links": [
    ]
}

Get VPC Configuration Restore Point Data

The HTTP GET request to the /vpc/restorePoints/{vpcRestorePointId} endpoint retrieves information on a restore point with the specified ID.

SecurityBearer
Request
path Parameters
vpcRestorePointId
required
string <uuid>

System ID assigned to a VPC configuration restore point in the Veeam Backup for AWS REST API.

Example: 267e0938-6640-49b9-a6c3-c3b6942214ab
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/vpc/restorePoints/{vpcRestorePointId}
Request samples 
curl -i -X GET \
  'https://helpcenter.veeam.com/api/v1/vpc/restorePoints/{vpcRestorePointId}' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'x-api-version: 1.7-rev0'
Response samples
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "backupId": "eb7cea43-10b2-42dd-8819-ab9aed37565f",
  • "pointInTime": "2019-08-24T14:15:22Z",
  • "region": "string",
  • "awsAccountId": "string",
  • "hasS3Backup": true,
  • "immutabilityInfo": {
    },
  • "_links": [
    ]
}

Get Backed-Up VPC Configuration Items

The HTTP GET request to the /vpc/restorePoints/{vpcRestorePointId}/items endpoint retrieves a list of backed-up VPC configuration items from a restore point with the specified ID.

SecurityBearer
Request
path Parameters
vpcRestorePointId
required
string <uuid>

System ID assigned to a VPC configuration restore point in the Veeam Backup for AWS REST API.

Example: 267e0938-6640-49b9-a6c3-c3b6942214ab
query Parameters
Name
string

Returns VPC configuration items with the specified name.

IncludeDeleted
boolean

Defines whether to include in the response items that were deleted from the configuration.

Type
Array of strings

Returns VPC configuration items of the specified type.

Items Enum: "Vpc" "Subnet" "Endpoint" "RouteTable" "VpcAttribute" "SecurityGroup" "NetworkInterface" "Acl" "NatGateway" "InternetGateway" "ElasticIp" "ManagedPrefixList" "CustomerGateway" "EgressOnlyInternetGateway" "VirtualPrivateGateway" "VpnConnection" "ClientVPNEndpoint" "PeeringConnection" "DHCPOptionsSet" "EndpointServices" "LoadBalancers" "LoadBalancersV2" "TargetGroups" "TransitGateway" "TransitGatewayRouteTable" "TransitGatewayMulticastDomain" "TransitGatewayAttachment"
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 (EVpcItemsRequestOrderColumn)

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" "typeAsc" "typeDesc" "lastModificationPointInTimeAsc" "lastModificationPointInTimeDesc"
ResourceAwsOrganizationId
string

Returns VPC configuration items that belong to an AWS Organization with the specified AWS ID.

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/restorePoints/{vpcRestorePointId}/items
Request samples 
curl -i -X GET \
  'https://helpcenter.veeam.com/api/v1/vpc/restorePoints/{vpcRestorePointId}/items?Name=string&IncludeDeleted=true&Type=Vpc&Offset=0&Limit=-1&Sort=nameAsc&ResourceAwsOrganizationId=string' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'x-api-version: 1.7-rev0'
Response samples
{
  • "totalCount": 0,
  • "data": [
    ],
  • "_links": [
    ]
}

Get Collection of Backed-Up VPCs

The HTTP GET request to the /vpc/restorePoints/{vpcRestorePointId}/vpcs endpoint retrieves a list of backed-up VPCs from a restore point with the specified ID.

SecurityBearer
Request
path Parameters
vpcRestorePointId
required
string <uuid>

System ID assigned to a VPC configuration restore point in the Veeam Backup for AWS REST API.

Example: 267e0938-6640-49b9-a6c3-c3b6942214ab
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/vpc/restorePoints/{vpcRestorePointId}/vpcs
Request samples 
curl -i -X GET \
  'https://helpcenter.veeam.com/api/v1/vpc/restorePoints/{vpcRestorePointId}/vpcs' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'x-api-version: 1.7-rev0'
Response samples
{
  • "data": [
    ]
}

Check IAM Role Permissions

The HTTP POST request to the /vpc/restorePoints/{vpcRestorePointId}/validateVpcRole endpoint checks whether an IAM Role has all required permissions to perform restore of VPC configuration.

SecurityBearer
Request
path Parameters
vpcRestorePointId
required
string <uuid>

System ID assigned to a VPC configuration restore point in the Veeam Backup for AWS REST API.

Example: 267e0938-6640-49b9-a6c3-c3b6942214ab
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:
required
locationId
string <uuid>

System ID assigned in the Veeam Backup for AWS REST API to the AWS Region where you plan to restore VPC configuration.

object (AuthenticationSpecification)

Specifies authentication settings used to perform the restore operation.

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/restorePoints/{vpcRestorePointId}/validateVpcRole
Request samples
{
  • "locationId": "1a5515a3-ba81-4a42-aee7-ad9ffc090a54",
  • "authenticationSpecification": {
    }
}
Response samples
{
  • "succeeded": true
}

Compare VPC Configuration

The HTTP POST request to the /vpc/restorePoints/{vpcRestorePointId}/compareWithProduction endpoint allows you to compare the current Amazon VPC configuration of an AWS Region with the VPC configuration restore point.

SecurityBearer
Request
path Parameters
vpcRestorePointId
required
string <uuid>

System ID assigned to a VPC configuration restore point in the Veeam Backup for AWS REST API.

Example: 267e0938-6640-49b9-a6c3-c3b6942214ab
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:
required
items
required
Array of strings unique

A list of VPC configuration items.

onlyDifferent
required
boolean

Defines whether to return only VPC configuration items whose settings have been changed since the restore point had been created.

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/restorePoints/{vpcRestorePointId}/compareWithProduction
Request samples
{
  • "items": [
    ],
  • "onlyDifferent": true
}
Response samples
{
  • "name": "string",
  • "type": "none",
  • "old": "string",
  • "new": "string",
  • "children": [
    ]
}

Perform VPC Configuration Restore

The HTTP POST request to the /vpc/restorePoints/{vpcRestorePointId}/restore endpoint performs restore of VPC configuration to a restore point with the specified ID.

SecurityBearer
Request
path Parameters
vpcRestorePointId
required
string <uuid>

System ID assigned to a VPC configuration restore point in the Veeam Backup for AWS REST API.

Example: 267e0938-6640-49b9-a6c3-c3b6942214ab
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:
required
required
Array of objects (VpcRestoreItem) unique

A list of VPC configuration items that must be restored.

locationId
string <uuid>

System ID assigned in the Veeam Backup for AWS REST API to the AWS Region where you plan to restore VPC configuration.

object (AuthenticationSpecification)

Specifies authentication settings used to perform the restore operation.

object (VpcToAlternativeRestoreOptions)

[Applies if you want to restore to a new location or with different settings] Specifies restore settings.

reason
string

Specifies a reason for the restore operation.

isGranular
boolean

Defines whether you want to restore entire VPC configuration or the selected items.

object (VpcExportRestoreOptions)

[Applies if you want to export VPC configuration to a CloudFormation template] Specifies settings for the export VPC configuration operation.

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.

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/restorePoints/{vpcRestorePointId}/restore
Request samples
{
  • "locationId": "1a5515a3-ba81-4a42-aee7-ad9ffc090a54",
  • "authenticationSpecification": {
    },
  • "toAlternative": {
    },
  • "reason": "string",
  • "isGranular": true,
  • "items": [
    ],
  • "export": {
    }
}
Response samples
{}

Validate VPC Configuration Restore

The HTTP POST request to the /vpc/restorePoints/{vpcRestorePointId}/validateRestore endpoint verifies whether restore settings specified for the VPC configuration restore are valid.

SecurityBearer
Request
path Parameters
vpcRestorePointId
required
string <uuid>

System ID assigned to a VPC configuration restore point in the Veeam Backup for AWS REST API.

Example: 267e0938-6640-49b9-a6c3-c3b6942214ab
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:
required
required
Array of objects (VpcRestoreItem) unique

A list of VPC configuration items that must be restored.

locationId
string <uuid>

System ID assigned in the Veeam Backup for AWS REST API to the AWS Region where you plan to restore VPC configuration.

object (AuthenticationSpecification)

Specifies authentication settings used to perform the restore operation.

object (VpcToAlternativeRestoreOptions)

[Applies if you want to restore to a new location or with different settings] Specifies restore settings.

reason
string

Specifies a reason for the restore operation.

isGranular
boolean

Defines whether you want to restore entire VPC configuration or the selected items.

object (VpcExportRestoreOptions)

[Applies if you want to export VPC configuration to a CloudFormation template] Specifies settings for the export VPC configuration operation.

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/restorePoints/{vpcRestorePointId}/validateRestore
Request samples
{
  • "locationId": "1a5515a3-ba81-4a42-aee7-ad9ffc090a54",
  • "authenticationSpecification": {
    },
  • "toAlternative": {
    },
  • "reason": "string",
  • "isGranular": true,
  • "items": [
    ],
  • "export": {
    }
}
Response samples
[
  • {
    }
]

Export Backed-Up VPC Configuration

The HTTP POST request to the /vpc/restorePoints/{vpcRestorePointId}/export endpoint exports VPC configuration to an Amazon CloudFormation template.

SecurityBearer
Request
path Parameters
vpcRestorePointId
required
string <uuid>

System ID assigned to a VPC configuration restore point in the Veeam Backup for AWS REST API.

Example: 267e0938-6640-49b9-a6c3-c3b6942214ab
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:
required
required
Array of objects (VpcRestoreItem) unique

A list of VPC configuration items that must be restored.

locationId
string <uuid>

System ID assigned in the Veeam Backup for AWS REST API to the AWS Region where you plan to restore VPC configuration.

object (AuthenticationSpecification)

Specifies authentication settings used to perform the restore operation.

object (VpcToAlternativeRestoreOptions)

[Applies if you want to restore to a new location or with different settings] Specifies restore settings.

reason
string

Specifies a reason for the restore operation.

isGranular
boolean

Defines whether you want to restore entire VPC configuration or the selected items.

object (VpcExportRestoreOptions)

[Applies if you want to export VPC configuration to a CloudFormation template] Specifies settings for the export VPC configuration operation.

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/restorePoints/{vpcRestorePointId}/export
Request samples
{
  • "locationId": "1a5515a3-ba81-4a42-aee7-ad9ffc090a54",
  • "authenticationSpecification": {
    },
  • "toAlternative": {
    },
  • "reason": "string",
  • "isGranular": true,
  • "items": [
    ],
  • "export": {
    }
}
Response samples
{}

Remove VPC Configuration Backups

The HTTP POST request to the /vpc/restorePoints/cleanup endpoint removes VPC configuration backups of the specified AWS account.

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
object (VpcCleanupLocalSpecification)

Specifies VPC configuration backups that will be removed from the Veeam Backup for AWS infrastructure.

object (VpcCleanupS3Specification)

Specifies VPC configuration backups that will be removed from the backup repositories.

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/restorePoints/cleanup
Request samples
application/json
{
  • "localSpec": {
    },
  • "s3Spec": {
    }
}
Response samples
application/json
{}