Amazon Connections

The /amazonConnections resource collection represents Amazon Virtual Private Cloud connections. Resources of the /amazonConnections collection are used to configure network settings for AWS Regions where Veeam Backup for AWS launches worker instances, and to configure backup policy settings.

Get Collection of Amazon Connections

The HTTP GET request to the /amazonConnections endpoint retrieves a list of all Amazon connections added to 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

200

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).

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/amazonConnections

Request samples

curl
Python
JavaScript
C#
Go

curl -i -X GET \
  https://helpcenter.veeam.com/api/v1/amazonConnections \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'x-api-version: 1.7-rev0'

Response samples

{"totalCount": 2,
"results": [{"id": "2c7eb8fb-40e3-4495-9dc9-30f969277917",
"_links": [{"method": "GET",
"rel": "self",
"href": "https://123.123.123.123:11005/api/v1/amazonConnections/2c7eb8fb-40e3-4495-9dc9-30f969277917"
},
{"method": "DELETE",
"rel": "delete",
"href": "https://123.123.123.123:11005/api/v1/amazonConnections/2c7eb8fb-40e3-4495-9dc9-30f969277917"
},
{"method": "GET",
"rel": "CloudNetworks",
"href": "https://123.123.123.123:11005/api/v1/amazonConnections/2c7eb8fb-40e3-4495-9dc9-30f969277917/cloudNetworks"
}
]
},
{"id": "8591eeb5-b67d-4c24-be10-17c78e8304f1",
"_links": [{"method": "GET",
"rel": "self",
"href": "https://123.123.123.123:11005/api/v1/amazonConnections/8591eeb5-b67d-4c24-be10-17c78e8304f1"
},
{"method": "DELETE",
"rel": "delete",
"href": "https://123.123.123.123:11005/api/v1/amazonConnections/8591eeb5-b67d-4c24-be10-17c78e8304f1"
},
{"method": "GET",
"rel": "CloudNetworks",
"href": "https://123.123.123.123:11005/api/v1/amazonConnections/8591eeb5-b67d-4c24-be10-17c78e8304f1/cloudNetworks"
}
]
}
],
"_links": [{"method": "POST",
"rel": "create",
"href": "https://123.123.123.123:11005/api/v1/amazonConnections"
}
]
}

Add Amazon Connection

The HTTP POST request to the /amazonConnections endpoint adds an Amazon connection to 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: application/json
required

required	object (AuthenticationSpecification) Specifies authentication settings used to perform the restore operation.
RegionId required	string <uuid> Specifies the system ID assigned in the Veeam Backup for AWS REST API to an AWS Region for which the connection is added.

Responses

201

Created

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).

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/amazonConnections

Request samples

application/json

{"authenticationSpecification": {"authenticationType": "CloudAccount",
"IAMRoleId": "aa4928a2-2367-4a6b-a4a2-a6b4a825a0e3"
},
"regionId": "35981651-f781-4041-9300-02967d13b944"
}

Response samples

[{"id": "2c7eb8fb-40e3-4495-9dc9-30f969277917",
"_links": [{"method": "GET",
"rel": "self",
"href": "https://123.123.123.123:11005/api/v1/amazonConnections/2c7eb8fb-40e3-4495-9dc9-30f969277917"
},
{"method": "DELETE",
"rel": "delete",
"href": "https://123.123.123.123:11005/api/v1/amazonConnections/2c7eb8fb-40e3-4495-9dc9-30f969277917"
},
{"method": "GET",
"rel": "CloudNetworks",
"href": "https://123.123.123.123:11005/api/v1/amazonConnections/2c7eb8fb-40e3-4495-9dc9-30f969277917/cloudNetworks"
}
]
}
]

Get Amazon Connection Data

The HTTP GET request to the /amazonConnections/{amazonConnectionId} endpoint retrieves information on an Amazon connection with the specified ID.

SecurityBearer

Request

path Parameters

amazonConnectionId

required

string <uuid>

Specifies the system ID assigned to an Amazon connection in the Veeam Backup for AWS REST API.

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

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).

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/amazonConnections/{amazonConnectionId}

Request samples

curl
Python
JavaScript
C#
Go

curl -i -X GET \
  'https://helpcenter.veeam.com/api/v1/amazonConnections/{amazonConnectionId}' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'x-api-version: 1.7-rev0'

Response samples

[{"id": "2c7eb8fb-40e3-4495-9dc9-30f969277917",
"_links": [{"method": "GET",
"rel": "self",
"href": "https://123.123.123.123:11005/api/v1/amazonConnections/2c7eb8fb-40e3-4495-9dc9-30f969277917"
},
{"method": "DELETE",
"rel": "delete",
"href": "https://123.123.123.123:11005/api/v1/amazonConnections/2c7eb8fb-40e3-4495-9dc9-30f969277917"
},
{"method": "GET",
"rel": "CloudNetworks",
"href": "https://123.123.123.123:11005/api/v1/amazonConnections/2c7eb8fb-40e3-4495-9dc9-30f969277917/cloudNetworks"
}
]
}
]

Remove Amazon Connection

The HTTP DELETE request to the /amazonConnections/{amazonConnectionId} endpoint removes an Amazon connection with the specified ID.

SecurityBearer

Request

path Parameters

amazonConnectionId

required

string <uuid>

Specifies the system ID assigned to an Amazon connection in the Veeam Backup for AWS REST API.

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

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).

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/amazonConnections/{amazonConnectionId}

Request samples

curl
Python
JavaScript
C#
Go

curl -i -X DELETE \
  'https://helpcenter.veeam.com/api/v1/amazonConnections/{amazonConnectionId}' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -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": {"property1": { },
"property2": { }
}
}

Get Collection of Availability Zones

The HTTP GET request to the /amazonConnections/{amazonConnectionId}/availabilityZones endpoint retrieves a list of all Availability Zones in the AWS Region available to an Amazon connection with the specified ID.

SecurityBearer

Request

path Parameters

amazonConnectionId

required

string <uuid>

Specifies the system ID assigned to an Amazon connection in the Veeam Backup for AWS REST API.

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

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).

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/amazonConnections/{amazonConnectionId}/availabilityZones

Request samples

curl
Python
JavaScript
C#
Go

curl -i -X GET \
  'https://helpcenter.veeam.com/api/v1/amazonConnections/{amazonConnectionId}/availabilityZones' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'x-api-version: 1.7-rev0'

Response samples

{"totalCount": 3,
"results": [{"id": "6b30f7c0-85f4-4200-a51f-1c1d4a596f4e",
"name": "eu-north-1a",
"_links": [{"method": "GET",
"rel": "self",
"href": "https://123.123.123.123:11005/api/v1/cloudInfrastructure/regions/6b30f7c0-85f4-4200-a51f-1c1d4a596f4e"
},
{"method": "GET",
"rel": "self",
"href": "https://123.123.123.123:11005/api/v1/cloudInfrastructure/regions/6b30f7c0-85f4-4200-a51f-1c1d4a596f4e/zones"
}
]
},
{"id": "2df0b3e8-2245-4f28-8e64-b39ccae7a910",
"name": "eu-north-1b",
"_links": [{"method": "GET",
"rel": "self",
"href": "https://123.123.123.123:11005/api/v1/cloudInfrastructure/regions/2df0b3e8-2245-4f28-8e64-b39ccae7a910"
},
{"method": "GET",
"rel": "self",
"href": "https://123.123.123.123:11005/api/v1/cloudInfrastructure/regions/2df0b3e8-2245-4f28-8e64-b39ccae7a910/zones"
}
]
},
{"id": "f27b37dd-e243-42c3-a4ec-8b2ba3988a3d",
"name": "eu-north-1c",
"_links": [{"method": "GET",
"rel": "self",
"href": "https://123.123.123.123:11005/api/v1/cloudInfrastructure/regions/f27b37dd-e243-42c3-a4ec-8b2ba3988a3d"
},
{"method": "GET",
"rel": "self",
"href": "https://123.123.123.123:11005/api/v1/cloudInfrastructure/regions/f27b37dd-e243-42c3-a4ec-8b2ba3988a3d/zones"
}
]
}
],
"_links": [{"method": "GET",
"rel": "self",
"href": "https://123.123.123.123:11005/api/v1/amazonConnections/2c7eb8fb-40e3-4495-9dc9-30f969277917/availabilityZones"
}
]
}

Check Permissions for Performing Restore

The HTTP POST request to the /amazonConnections/{amazonConnectionId}/checkRestorePermissions endpoint verifies whether the IAM role of a specific Amazon connection has permissions to perform restore operations.

SecurityBearer

Request

path Parameters

amazonConnectionId

required

string <uuid>

Specifies the system ID assigned to an Amazon connection in the Veeam Backup for AWS REST API.

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

policyType

string (PolicyType)

Type of AWS services protected by Veeam Backup for AWS.

Enum: "Ec2" "Rds" "Vpc" "Efs" "ConfigurationBackup" "Fsx" "Redshift" "RedshiftServerless"

Responses

200

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/amazonConnections/{amazonConnectionId}/checkRestorePermissions

Request samples

application/json

{"policyType": "Ec2"
}

Response samples

{"overallResult": "Passed",
"checks": [{"type": "string",
"result": "Passed",
"details": "string"
}
]
}

Verify EC2 Instance Details

The HTTP POST request to the /amazonConnections/{amazonConnectionId}/checkEc2InstanceExists endpoint verifies whether an EC2 instance with the specified ID exists in the Veeam Backup for AWS database and returns detailed information on the instance.

SecurityBearer

Request

path Parameters

amazonConnectionId

required

string <uuid>

Specifies the system ID assigned to an Amazon connection in the Veeam Backup for AWS REST API.

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

instances

required

Array of strings <uuid>

System IDs assigned to instances in the Veeam Backup for AWS REST API.

Responses

200

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/amazonConnections/{amazonConnectionId}/checkEc2InstanceExists

Request samples

application/json

{"instances": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
]
}

Response samples

{"totalCount": 0,
"results": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"resourceId": "string",
"name": "string",
"locationId": "1a5515a3-ba81-4a42-aee7-ad9ffc090a54",
"locationName": "string",
"IAMRoleId": "31d997b7-510e-4a2c-a173-a131e417c339",
"IAMRoleName": "string",
"instanceType": "string",
"dnsName": "string"
}
],
"_links": [{"rel": "string",
"href": "string",
"method": "GET"
}
]
}

Verify RDS Resource Details

The HTTP POST request to the /amazonConnections/{amazonConnectionId}/checkRdsInstanceExists endpoint verifies whether an RDS resource with the specified ID exists in the Veeam Backup for AWS database and returns detailed information on the instance.

SecurityBearer

Request

path Parameters

amazonConnectionId

required

string <uuid>

Specifies the system ID assigned to an Amazon connection in the Veeam Backup for AWS REST API.

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

instances

required

Array of strings <uuid>

System IDs assigned to instances in the Veeam Backup for AWS REST API.

Responses

200

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/amazonConnections/{amazonConnectionId}/checkRdsInstanceExists

Request samples

application/json

{"instances": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
]
}

Response samples

{"totalCount": 0,
"results": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"resourceId": "string",
"dbiResourceId": "string",
"name": "string",
"deleteProtectionEnabled": true
}
],
"_links": [{"rel": "string",
"href": "string",
"method": "GET"
}
]
}

Get Collection of Encryption Keys

The HTTP GET request to the /amazonConnections/{amazonConnectionId}/cloudEncryptionKeys endpoint retrieves a list of all encryption keys used in an Amazon connection with the specified ID.

SecurityBearer

Request

path Parameters

amazonConnectionId

required

string <uuid>

Specifies the system ID assigned to an Amazon connection in the Veeam Backup for AWS REST API.

query Parameters

Offset	integer <int32> Excludes from a response the first N items of a resource collection.
Limit	integer <int32> Specifies the maximum number of items of a resource collection to return in a response.

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

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).

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/amazonConnections/{amazonConnectionId}/cloudEncryptionKeys

Request samples

curl
Python
JavaScript
C#
Go

curl -i -X GET \
  'https://helpcenter.veeam.com/api/v1/amazonConnections/{amazonConnectionId}/cloudEncryptionKeys?Offset=0&Limit=0' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'x-api-version: 1.7-rev0'

Response samples

{"totalCount": 3,
"results": [{"arn": "arn:aws:kms:eu-north-1:111111111111:key/55d664fc-2315-4dee-9acd-9f460022802a",
"name": "aws/backup"
},
{"arn": "arn:aws:kms:eu-north-1:111111111111:key/f5863fd8-c01a-4daa-bf53-07e2e40fa006",
"name": "aws/ebs"
},
{"arn": "arn:aws:kms:eu-north-1:111111111111:key/7e034548-645f-4f90-9c62-41062801cde4",
"name": "aws/rds"
}
],
"_links": [{"method": "GET",
"rel": "self",
"href": "https://123.123.123.123:11005/api/v1/amazonConnections/2c7eb8fb-40e3-4495-9dc9-30f969277917/cloudEncryptionKeys"
},
{"method": "GET",
"rel": "self",
"href": "https://123.123.123.123:11005/api/v1/amazonConnections/2c7eb8fb-40e3-4495-9dc9-30f969277917/cloudEncryptionKeys"
}
]
}

Get Collection of VPCs

The HTTP GET request to the /amazonConnections/{amazonConnectionId}/cloudNetworks endpoint retrieves a list of all virtual private clouds (VPC) available to an Amazon connection with the specified ID.

SecurityBearer

Request

path Parameters

amazonConnectionId

required

string <uuid>

Specifies the system ID assigned to an Amazon connection in the Veeam Backup for AWS REST API.

query Parameters

Offset	integer <int32> Excludes from a response the first N items of a resource collection.
Limit	integer <int32> Specifies the maximum number of items of a resource collection to return in a response.

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

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).

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/amazonConnections/{amazonConnectionId}/cloudNetworks

Request samples

curl
Python
JavaScript
C#
Go

curl -i -X GET \
  'https://helpcenter.veeam.com/api/v1/amazonConnections/{amazonConnectionId}/cloudNetworks?Offset=0&Limit=0' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'x-api-version: 1.7-rev0'

Response samples

{"totalCount": 2,
"results": [{"state": "Available",
"resourceId": "vpc-f3e40a9a",
"name": "Default Backup Restore",
"cidrBlock": "172.31.0.0/16",
"isDefault": true
},
{"state": "Available",
"resourceId": "vpc-02a8df746eacfcc4b",
"name": "drVeeam PN461 VPC",
"cidrBlock": "10.0.0.0/16",
"isDefault": false
}
],
"_links": [{"method": "GET",
"rel": "self",
"href": "https://123.123.123.123:11005/api/v1/amazonConnections/2c7eb8fb-40e3-4495-9dc9-30f969277917/cloudNetworks"
}
]
}

Get Collection of Security Groups

The HTTP GET request to the /amazonConnections/{amazonConnectionId}/cloudSecurityGroups endpoint retrieves a list of all security groups available to an Amazon connection with the specified ID.

SecurityBearer

Request

path Parameters

amazonConnectionId

required

string <uuid>

Specifies the system ID assigned to an Amazon connection in the Veeam Backup for AWS REST API.

query Parameters

cloudNetworkId	string Returns only security groups that belongs to an Amazon VPC with the specified AWS ID.
Offset	integer <int32> Excludes from a response the first N items of a resource collection.
Limit	integer <int32> Specifies the maximum number of items of a resource collection to return in a response.

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

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).

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/amazonConnections/{amazonConnectionId}/cloudSecurityGroups

Request samples

curl
Python
JavaScript
C#
Go

curl -i -X GET \
  'https://helpcenter.veeam.com/api/v1/amazonConnections/{amazonConnectionId}/cloudSecurityGroups?cloudNetworkId=string&Offset=0&Limit=0' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'x-api-version: 1.7-rev0'

Response samples

{"totalCount": 3,
"results": [{"resourceId": "sg-072348669ba4a6bda",
"cloudNetworkResourceId": "vpc-02a8df746eacfcc4b",
"name": "default"
},
{"resourceId": "sg-a39e55ca",
"cloudNetworkResourceId": "vpc-f3e40a9a",
"name": "default"
},
{"resourceId": "sg-0ecef1260102bbe50",
"cloudNetworkResourceId": "vpc-02a8df746eacfcc4b",
"name": "dr-461-VeeampnSecurityGroup-BECUKT2MSQX0"
}
],
"_links": [{"method": "GET",
"rel": "self",
"href": "https://123.123.123.123:11005/api/v1/amazonConnections/2c7eb8fb-40e3-4495-9dc9-30f969277917/cloudSecurityGroups"
}
]
}

Get Collection of Route Tables

The HTTP GET request to the /amazonConnections/{amazonConnectionId}/cloudRouteTables endpoint retrieves a list of all route tables available for an Amazon connection with the specified ID.

SecurityBearer

Request

path Parameters

amazonConnectionId

required

string <uuid>

Specifies the system ID assigned to an Amazon connection in the Veeam Backup for AWS REST API.

query Parameters

cloudNetworkId	string Returns only route tables that belongs to an Amazon VPC with the specified AWS ID.
Offset	integer <int32> Excludes from a response the first N items of a resource collection.
Limit	integer <int32> Specifies the maximum number of items of a resource collection to return in a response.

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

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).

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/amazonConnections/{amazonConnectionId}/cloudRouteTables

Request samples

curl
Python
JavaScript
C#
Go

curl -i -X GET \
  'https://helpcenter.veeam.com/api/v1/amazonConnections/{amazonConnectionId}/cloudRouteTables?cloudNetworkId=string&Offset=0&Limit=0' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'x-api-version: 1.7-rev0'

Response samples

{"totalCount": 3,
"results": [{"resourceId": "rtb-072348669ba4a6bda",
"cloudNetworkResourceId": "vpc-02a8df746eacfcc4b",
"name": "default"
},
{"resourceId": "rtb-a39e55ca",
"cloudNetworkResourceId": "vpc-f3e40a9a",
"name": "default"
},
{"resourceId": "rtb-0ecef1260102bbe50",
"cloudNetworkResourceId": "vpc-02a8df746eacfcc4b",
"name": "dr-461-RouteTable-BECUKT2MSQX0"
}
],
"_links": [{"method": "GET",
"rel": "self",
"href": "https://123.123.123.123:11005/api/v1/amazonConnections/2c7eb8fb-40e3-4495-9dc9-30f969277917/cloudSecurityGroups"
}
]
}

Get Collection of Amazon Machine Images

The HTTP GET request to the /amazonConnections/{amazonConnectionId}/images endpoint retrieves a list of Amazon Machine Images (AMIs) available for performing restore from a specific restore point for an Amazon connection with the specified ID.

NOTE
To increase readability and optimize network traffic, Veeam Backup for AWS REST API applies pagination to this request — the default number of resources to be returned in the response is 100. You can modify this number using the limit query parameter and skip resources using the offset query parameter.

SecurityBearer

Request

path Parameters

amazonConnectionId

required

string <uuid>

Specifies the system ID assigned to an Amazon connection in the Veeam Backup for AWS REST API.

query Parameters

restorePointId required	string <uuid> Specifies the system ID assigned to a restore point in the Veeam Backup for AWS REST API.
offset	integer <int32> Excludes from a response the first N items of a resource collection.
limit	integer <int32> Specifies the maximum number of items of a resource collection to return in a response.
amiIdOrName	string Specifies an ID or name of the AMI.
orderColumn	string Specifies a property that will be used to sort items of a resource collection in a response. Enum: "id" "name"
orderAsc	boolean Defines whether the resource collection representation will be in the ascending or descending order.

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

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

get/api/v1/amazonConnections/{amazonConnectionId}/images

Request samples

curl
Python
JavaScript
C#
Go

curl -i -X GET \
  'https://helpcenter.veeam.com/api/v1/amazonConnections/{amazonConnectionId}/images?restorePointId=497f6eca-6276-4993-bfeb-53cbbbba6f08&offset=0&limit=0&amiIdOrName=string&orderColumn=id&orderAsc=true' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'x-api-version: 1.7-rev0'

Response samples

application/json

{"data": [{"imageId": "string",
"imageName": "string"
}
],
"totalCount": 0
}

Verify EC2 Instance AMI

The HTTP POST request to the /amazonConnections/{amazonConnectionId}/checkOriginalImages endpoint retrieves information on availability of original AMIs that were used to launch source EC2 instances.

SecurityBearer

Request

path Parameters

amazonConnectionId

required

string <uuid>

Specifies the system ID assigned to an Amazon connection in the Veeam Backup for AWS REST API.

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

restorePoints

required

Array of strings <uuid> unique

Specifies system IDs of restore points that will be used to perform restore.

Responses

200

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/amazonConnections/{amazonConnectionId}/checkOriginalImages

Request samples

application/json

{"restorePoints": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
]
}

Response samples

application/json

{"result": [{"restorePointId": "8c843d10-6d0f-4abe-b898-e1ba18b94f68",
"originalImageFound": true,
"imageId": "string",
"imageName": "string",
"originalImageId": "string",
"originalImageName": "string",
"messages": ["string"
]
}
]
}

Get Collection of Subnets

The HTTP GET request to the /amazonConnections/{amazonConnectionId}/cloudSubnetworks endpoint retrieves a list of all subnets available to an Amazon connection with the specified ID.

SecurityBearer

Request

path Parameters

amazonConnectionId

required

string <uuid>

Specifies the system ID assigned to an Amazon connection in the Veeam Backup for AWS REST API.

query Parameters

cloudNetworkId	string Returns only subnet that belongs to an Amazon VPC with the specified AWS ID.
availabilityZone	string <uuid> Returns only subnet that placed in an Availability Zone with the specified ID.
Offset	integer <int32> Excludes from a response the first N items of a resource collection.
Limit	integer <int32> Specifies the maximum number of items of a resource collection to return in a response.

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

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).

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/amazonConnections/{amazonConnectionId}/cloudSubnetworks

Request samples

curl
Python
JavaScript
C#
Go

curl -i -X GET \
  'https://helpcenter.veeam.com/api/v1/amazonConnections/{amazonConnectionId}/cloudSubnetworks?cloudNetworkId=string&availabilityZone=497f6eca-6276-4993-bfeb-53cbbbba6f08&Offset=0&Limit=0' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'x-api-version: 1.7-rev0'

Response samples

{"totalCount": 2,
"results": [{"resourceId": "subnet-0b23920a483b0ce42",
"name": "subnet-dept1",
"cloudNetworkResourceId": "vpc-02a8df746eacfcc4b",
"cidrBlock": "10.0.1.0/24",
"availabilityZone": "eu-north-1c"
},
{"resourceId": "subnet-00a48d4a",
"name": "subnet-dept2",
"cloudNetworkResourceId": "vpc-f3e40a9a",
"cidrBlock": "172.31.0.0/20",
"availabilityZone": "eu-north-1c"
}
],
"_links": [{"method": "GET",
"rel": "self",
"href": "https://123.123.123.123:11005/api/v1/amazonConnections/2c7eb8fb-40e3-4495-9dc9-30f969277917/cloudSubnetworks"
}
]
}

Get Collection of AWS Outposts

The HTTP GET request to the /amazonConnections/{amazonConnectionId}/outposts endpoint retrieves a list of all AWS Outposts available to an Amazon connection with the specified ID.

SecurityBearer

Request

path Parameters

amazonConnectionId

required

string <uuid>

Specifies the system ID assigned to an Amazon connection in the Veeam Backup for AWS REST API.

query Parameters

Offset	integer <int32> Excludes from a response the first N items of a resource collection.
Limit	integer <int32> Specifies the maximum number of items of a resource collection to return in a response.
AvailabilityZone	string Returns only AWS Outposts connected to an Availability Zone with the specified 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

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/amazonConnections/{amazonConnectionId}/outposts

Request samples

curl
Python
JavaScript
C#
Go

curl -i -X GET \
  'https://helpcenter.veeam.com/api/v1/amazonConnections/{amazonConnectionId}/outposts?Offset=0&Limit=0&AvailabilityZone=string' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'x-api-version: 1.7-rev0'

Response samples

{"totalCount": 0,
"results": [{"id": "string",
"name": "string",
"description": "string",
"availabilityZone": "string"
}
],
"_links": [{"rel": "string",
"href": "string",
"method": "GET"
}
]
}

Get Collection of Option Groups

The HTTP GET request to the /amazonConnections/{amazonConnectionId}/rdsOptionGroups endpoint retrieves a list of all option groups available to an Amazon connection with the specified ID.

SecurityBearer

Request

path Parameters

amazonConnectionId

required

string <uuid>

Specifies the system ID assigned to an Amazon connection in the Veeam Backup for AWS REST API.

query Parameters

engine	string Returns only option groups for the specified database engine.
engineVersion	string Returns only option groups for the specified database engine version.
restorePoint	string <uuid> Returns only option groups stored in a restore point with the specified 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

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/amazonConnections/{amazonConnectionId}/rdsOptionGroups

Request samples

curl
Python
JavaScript
C#
Go

curl -i -X GET \
  'https://helpcenter.veeam.com/api/v1/amazonConnections/{amazonConnectionId}/rdsOptionGroups?engine=string&engineVersion=string&restorePoint=497f6eca-6276-4993-bfeb-53cbbbba6f08' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'x-api-version: 1.7-rev0'

Response samples

{"totalCount": 0,
"results": [{"name": "string"
}
],
"_links": [{"rel": "string",
"href": "string",
"method": "GET"
}
]
}

Get Collection of Parameter Groups

The HTTP GET request to the /amazonConnections/{amazonConnectionId}/rdsParameterGroups endpoint retrieves a list of all RDS parameter groups available for an Amazon connection with the specified ID.

SecurityBearer

Request

path Parameters

amazonConnectionId

required

string <uuid>

Specifies the system ID assigned to an Amazon connection in the Veeam Backup for AWS REST API.

query Parameters

engine	string Returns only parameter groups for the specified database engine.
engineVersion	string Returns only parameter groups for the specified database engine version.

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

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/amazonConnections/{amazonConnectionId}/rdsParameterGroups

Request samples

curl
Python
JavaScript
C#
Go

curl -i -X GET \
  'https://helpcenter.veeam.com/api/v1/amazonConnections/{amazonConnectionId}/rdsParameterGroups?engine=string&engineVersion=string' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'x-api-version: 1.7-rev0'

Response samples

{"totalCount": 0,
"results": [{"name": "string"
}
],
"_links": [{"rel": "string",
"href": "string",
"method": "GET"
}
]
}

Get Collection of Cluster Parameter Groups

The HTTP GET request to the /amazonConnections/{amazonConnectionId}/rdsClusterParameterGroups endpoint retrieves a list of all cluster parameter groups available for an Amazon connection with the specified ID.

SecurityBearer

Request

path Parameters

amazonConnectionId

required

string <uuid>

Specifies the system ID assigned to an Amazon connection in the Veeam Backup for AWS REST API.

query Parameters

engine	string Returns only parameter groups for the specified database engine.
engineVersion	string Returns only parameter groups for the specified database engine version.

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

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/amazonConnections/{amazonConnectionId}/rdsClusterParameterGroups

Request samples

curl
Python
JavaScript
C#
Go

curl -i -X GET \
  'https://helpcenter.veeam.com/api/v1/amazonConnections/{amazonConnectionId}/rdsClusterParameterGroups?engine=string&engineVersion=string' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'x-api-version: 1.7-rev0'

Response samples

{"totalCount": 0,
"results": [{"name": "string"
}
],
"_links": [{"rel": "string",
"href": "string",
"method": "GET"
}
]
}

Get Collection of DB Subnet Groups

The HTTP GET request to the /amazonConnections/{amazonConnectionId}/rdsSubnetGroups endpoint retrieves a list of all DB subnet groups available for an Amazon connection with the specified ID.

SecurityBearer

Request

path Parameters

amazonConnectionId

required

string <uuid>

Specifies the system ID assigned to an Amazon connection in the Veeam Backup for AWS REST API.

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

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/amazonConnections/{amazonConnectionId}/rdsSubnetGroups

Request samples

curl
Python
JavaScript
C#
Go

curl -i -X GET \
  'https://helpcenter.veeam.com/api/v1/amazonConnections/{amazonConnectionId}/rdsSubnetGroups' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'x-api-version: 1.7-rev0'

Response samples

{"totalCount": 0,
"results": [{"vpcId": "string",
"vpcName": "string",
"vpcIsDefault": true,
"subnetGroups": [{"name": "string",
"locations": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string"
}
]
}
]
}
],
"_links": [{"rel": "string",
"href": "string",
"method": "GET"
}
]
}

Get Collection of VPC Security Groups

The HTTP GET request to the /amazonConnections/{amazonConnectionId}/rdsSecurityGroups endpoint retrieves a list of all VPC security groups that can be associated with RDS resources and are available for an Amazon connection with the specified ID.

SecurityBearer

Request

path Parameters

amazonConnectionId

required

string <uuid>

Specifies the system ID assigned to an Amazon connection in the Veeam Backup for AWS REST API.

query Parameters

SearchPattern	string Returns only VPC security groups with the names containing the specified value. Note: Values of both parameters `name` and `displayName` are considered as a name of a VPC security group.
offset	integer <int32> Excludes from a response the first N items of a resource collection.
limit	integer <int32> Specifies the maximum number of items of a resource collection to return in a response.

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

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/amazonConnections/{amazonConnectionId}/rdsSecurityGroups

Request samples

curl
Python
JavaScript
C#
Go

curl -i -X GET \
  'https://helpcenter.veeam.com/api/v1/amazonConnections/{amazonConnectionId}/rdsSecurityGroups?SearchPattern=string&offset=0&limit=0' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'x-api-version: 1.7-rev0'

Response samples

{"totalCount": 0,
"results": [{"name": "string",
"displayName": "string",
"vpcId": "string"
}
],
"_links": [{"rel": "string",
"href": "string",
"method": "GET"
}
]
}

Get Collection of RDS Licenses

The HTTP GET request to the /amazonConnections/{amazonConnectionId}/rdsLicense endpoint retrieves a list of RDS licenses available for an Amazon connection with the specified ID.

SecurityBearer

Request

path Parameters

amazonConnectionId

required

string <uuid>

Specifies the system ID assigned to an Amazon connection in the Veeam Backup for AWS REST API.

query Parameters

engine required	string Returns only RDS licenses for the specified database engine.
engineVersion required	string Returns only RDS licenses for the specified database engine version.

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

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/amazonConnections/{amazonConnectionId}/rdsLicense

Request samples

curl
Python
JavaScript
C#
Go

curl -i -X GET \
  'https://helpcenter.veeam.com/api/v1/amazonConnections/{amazonConnectionId}/rdsLicense?engine=string&engineVersion=string' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'x-api-version: 1.7-rev0'

Response samples

{"totalCount": 0,
"results": ["string"
],
"_links": [{"rel": "string",
"href": "string",
"method": "GET"
}
]
}

Get Collection of DB Instance Classes

The HTTP GET request to the /amazonConnections/{amazonConnectionId}/rdsInstanceClasses endpoint retrieves a list of all DB instance classes available for an Amazon connection with the specified ID.

SecurityBearer

Request

path Parameters

amazonConnectionId

required

string <uuid>

Specifies the system ID assigned to an Amazon connection in the Veeam Backup for AWS REST API.

query Parameters

engine required	string Returns only instance classes with the specified database engine.
engineVersion required	string Returns only instance classes with the specified version of the database engine.
license	string Returns only instance classes with the specified license type.

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

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/amazonConnections/{amazonConnectionId}/rdsInstanceClasses

Request samples

curl
Python
JavaScript
C#
Go

curl -i -X GET \
  'https://helpcenter.veeam.com/api/v1/amazonConnections/{amazonConnectionId}/rdsInstanceClasses?engine=string&engineVersion=string&license=string' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'x-api-version: 1.7-rev0'

Response samples

{"totalCount": 0,
"results": [{"name": "string",
"cpuCount": 0,
"ram": 0,
"storageType": ["Standard"
]
}
],
"_links": [{"rel": "string",
"href": "string",
"method": "GET"
}
]
}

Validate S3 Endpoint

The HTTP GET request to the /amazonConnections/{amazonConnectionId}/validateS3endpoint endpoint verifies whether an S3 endpoint is configured for a specific subnet that belongs to an Amazon connection with the specified ID.

SecurityBearer

Request

path Parameters

amazonConnectionId

required

string <uuid>

Specifies the system ID assigned to an Amazon connection in the Veeam Backup for AWS REST API.

query Parameters

subnetId

required

string

Specifies the AWS ID of the subnet.

Example: subnetId=subnet-0b23920a483b0ce42

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

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).

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/amazonConnections/{amazonConnectionId}/validateS3endpoint

Request samples

curl
Python
JavaScript
C#
Go

curl -i -X GET \
  'https://helpcenter.veeam.com/api/v1/amazonConnections/{amazonConnectionId}/validateS3endpoint?subnetId=string' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'x-api-version: 1.7-rev0'

Response samples

{"isValid": false,
"details": "S3 endpoint for selected subnet is not configured."
}

Validate Worker Settings

The HTTP POST request to the /amazonConnections/{amazonConnectionId}/validateWorker endpoint checks whether configured worker settings are valid for an Amazon connection with the specified ID.

SecurityBearer

Request

path Parameters

amazonConnectionId

required

string <uuid>

Specifies the system ID assigned to an Amazon connection in the Veeam Backup for AWS REST API.

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

subnetId

string

Specifies the AWS ID of the subnet used to launch worker instances.

Responses

200

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/amazonConnections/{amazonConnectionId}/validateWorker

Request samples

application/json

{"subnetId": "string"
}

Response samples

{"severity": "Success",
"message": "string",
"helpMessage": "string"
}

Get Collection of AWS Managed Microsoft Active Directories (ADs)

The HTTP GET request to the /amazonConnections/{amazonConnectionId}/cloudDirectories endpoint retrieves a list of all AWS Managed Microsoft ADs available for an Amazon connection with the specified ID.

SecurityBearer

Request

path Parameters

amazonConnectionId

required

string <uuid>

Specifies the system ID assigned to an Amazon connection in the Veeam Backup for AWS REST API.

query Parameters

Offset	integer <int32> Excludes from a response the first N items of a resource collection.
Limit	integer <int32> Specifies the maximum number of items of a resource collection to return in a response.

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

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).

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/amazonConnections/{amazonConnectionId}/cloudDirectories

Request samples

curl
Python
JavaScript
C#
Go

curl -i -X GET \
  'https://helpcenter.veeam.com/api/v1/amazonConnections/{amazonConnectionId}/cloudDirectories?Offset=0&Limit=0' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'x-api-version: 1.7-rev0'

Response samples

{"totalCount": 3,
"results": [{"resourceId": "d-12342",
"name": "di1.local"
},
{"resourceId": "d-232321",
"name": "dir2.local"
}
],
"_links": [{"method": "GET",
"rel": "self",
"href": "https://123.123.123.123:11005/api/v1/amazonConnections/2c7eb8fb-40e3-4495-9dc9-30f969277917/cloudDirectories"
},
{"method": "GET",
"rel": "self",
"href": "https://123.123.123.123:11005/api/v1/amazonConnections/2c7eb8fb-40e3-4495-9dc9-30f969277917/cloudDirectories"
}
]
}

Get Collection of Redshift Subnet Groups

The HTTP GET request to the /amazonConnections/{amazonConnectionId}/redshiftSubnetGroups endpoint retrieves a list of all Redshift subnet groups available for an Amazon connection with the specified ID.

SecurityBearer

Request

path Parameters

amazonConnectionId

required

string <uuid>

Specifies the system ID assigned to an Amazon connection in the Veeam Backup for AWS REST API.

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

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/amazonConnections/{amazonConnectionId}/redshiftSubnetGroups

Request samples

curl
Python
JavaScript
C#
Go

curl -i -X GET \
  'https://helpcenter.veeam.com/api/v1/amazonConnections/{amazonConnectionId}/redshiftSubnetGroups' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'x-api-version: 1.7-rev0'

Response samples

{"totalCount": 0,
"results": [{"vpcId": "string",
"vpcName": "string",
"vpcIsDefault": true,
"subnetGroups": [{"name": "string",
"locations": ["string"
]
}
]
}
],
"_links": [{"rel": "string",
"href": "string",
"method": "GET"
}
]
}

Get Collection of Redshift Parameter Groups

The HTTP GET request to the /amazonConnections/{amazonConnectionId}/redshiftParameterGroups endpoint retrieves a list of all Redshift parameter groups available for an Amazon connection with the specified ID.

SecurityBearer

Request

path Parameters

amazonConnectionId

required

string <uuid>

Specifies the system ID assigned to an Amazon connection in the Veeam Backup for AWS REST API.

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

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/amazonConnections/{amazonConnectionId}/redshiftParameterGroups

Request samples

curl
Python
JavaScript
C#
Go

curl -i -X GET \
  'https://helpcenter.veeam.com/api/v1/amazonConnections/{amazonConnectionId}/redshiftParameterGroups' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'x-api-version: 1.7-rev0'

Response samples

{"totalCount": 0,
"results": [{"name": "string"
}
],
"_links": [{"rel": "string",
"href": "string",
"method": "GET"
}
]
}

Get Collection of Redshift Node Configurations

The HTTP GET request to the /amazonConnections/{amazonConnectionId}/redshiftNodeOptions/{restorePointId} endpoint retrieves a list of all possible Redshift node configurations available for an Amazon connection with the specified ID.

SecurityBearer

Request

path Parameters

amazonConnectionId required	string <uuid> Specifies the system ID assigned to an Amazon connection in the Veeam Backup for AWS REST API.
restorePointId required	string <uuid> Specifies the system ID assigned in the Veeam Backup for AWS REST API to the restore point that will be used to determine possible node configurations.

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

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/amazonConnections/{amazonConnectionId}/redshiftNodeOptions/{restorePointId}

Request samples

curl
Python
JavaScript
C#
Go

curl -i -X GET \
  'https://helpcenter.veeam.com/api/v1/amazonConnections/{amazonConnectionId}/redshiftNodeOptions/{restorePointId}' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'x-api-version: 1.7-rev0'

Response samples

{"totalCount": 0,
"results": [{"nodeType": "string",
"numberOfNodesOptions": [0
]
}
],
"_links": [{"rel": "string",
"href": "string",
"method": "GET"
}
]
}

Get Collection of IAM roles

The HTTP GET request to the /amazonConnections/{amazonConnectionId}/iamRoles endpoint retrieves a list of all IAM roles available for an Amazon connection with the specified ID.

SecurityBearer

Request

path Parameters

amazonConnectionId

required

string <uuid>

Specifies the system ID assigned to an Amazon connection in the Veeam Backup for AWS REST API.

query Parameters

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

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/amazonConnections/{amazonConnectionId}/iamRoles

Request samples

curl
Python
JavaScript
C#
Go

curl -i -X GET \
  'https://helpcenter.veeam.com/api/v1/amazonConnections/{amazonConnectionId}/iamRoles?searchPattern=string' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'x-api-version: 1.7-rev0'

Response samples

{"totalCount": 0,
"results": [{"name": "string",
"arn": "string"
}
],
"_links": [{"rel": "string",
"href": "string",
"method": "GET"
}
]
}

Get Collection of Instance Profiles

The HTTP GET request to the /amazonConnections/{amazonConnectionId}/instanceProfiles endpoint retrieves a list of all instance profiles available for an Amazon connection with the specified ID.

SecurityBearer

Request

path Parameters

amazonConnectionId

required

string <uuid>

Specifies the system ID assigned to an Amazon connection in the Veeam Backup for AWS REST API.

query Parameters

SearchPattern	string Returns only those items of a resource collection whose names match the specified search pattern in the parameter value.
Sort	string Specifies the order of items in the response. For more information, see the Veeam Backup for AWS REST API Reference Overview, section Sort Parameter. Enum: "arnDesc" "arnAsc" "iamRoleArnDesc" "iamRoleArnAsc"

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

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/amazonConnections/{amazonConnectionId}/instanceProfiles

Request samples

curl
Python
JavaScript
C#
Go

curl -i -X GET \
  'https://helpcenter.veeam.com/api/v1/amazonConnections/{amazonConnectionId}/instanceProfiles?SearchPattern=string&Sort=arnDesc' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'x-api-version: 1.7-rev0'

Response samples

{"totalCount": 0,
"results": [{"arn": "string",
"name": "string",
"iamRoleArn": "string"
}
],
"_links": [{"rel": "string",
"href": "string",
"method": "GET"
}
]
}

Amazon Connections

Get Collection of Amazon Connections

header Parameters

Add Amazon Connection

header Parameters

Request Body schema: application/jsonrequired

Get Amazon Connection Data

path Parameters

header Parameters

Remove Amazon Connection

path Parameters

header Parameters

Get Collection of Availability Zones

path Parameters

header Parameters

Check Permissions for Performing Restore

path Parameters

header Parameters

Request Body schema: application/jsonrequired

Verify EC2 Instance Details

path Parameters

header Parameters

Request Body schema: application/jsonrequired

Verify RDS Resource Details

path Parameters

header Parameters

Request Body schema: application/jsonrequired

Get Collection of Encryption Keys

path Parameters

query Parameters

header Parameters

Get Collection of VPCs

path Parameters

query Parameters

header Parameters

Get Collection of Security Groups

path Parameters

query Parameters

header Parameters

Get Collection of Route Tables

path Parameters

query Parameters

header Parameters

Get Collection of Amazon Machine Images

path Parameters

query Parameters

header Parameters

Verify EC2 Instance AMI

path Parameters

header Parameters

Request Body schema: application/jsonrequired

Get Collection of Subnets

path Parameters

query Parameters

header Parameters

Get Collection of AWS Outposts

path Parameters

query Parameters

header Parameters

Get Collection of Option Groups

path Parameters

query Parameters

header Parameters

Get Collection of Parameter Groups

path Parameters

query Parameters

header Parameters

Get Collection of Cluster Parameter Groups

path Parameters

query Parameters

header Parameters

Get Collection of DB Subnet Groups

path Parameters

header Parameters

Get Collection of VPC Security Groups

path Parameters

query Parameters

header Parameters

Get Collection of RDS Licenses

path Parameters

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required