AWS Regions

The /regions resource collection represents all AWS Regions available to the AWS account where the EC2 instance hosting Veeam Backup for AWS runs.

Get Collection of AWS Regions

The HTTP GET request to the /regions endpoint retrieves a list of all AWS Regions available in the AWS account.

SecurityBearer

Request

query Parameters

SearchPattern	string Returns only those items of a resource collection whose names match the specified search pattern in the parameter value.
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.
Sort	Array of strings (RegionsSortColumns) 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"

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/cloudInfrastructure/regions

Request samples

curl
Python
JavaScript
C#
Go

curl -i -X GET \
  'https://helpcenter.veeam.com/api/v1/cloudInfrastructure/regions?SearchPattern=string&Offset=0&Limit=0&Sort=nameAsc' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'x-api-version: 1.7-rev0'

Response samples

{"totalCount": 2,
"results": [{"id": "226fd676-b501-445c-9f48-77b6f456b2f8",
"name": "af-south-1",
"_links": [{"method": "GET",
"rel": "self",
"href": "https://123.123.123.123:11005/api/v1/cloudInfrastructure/regions/226fd676-b501-445c-9f48-77b6f456b2f8"
},
{"method": "GET",
"rel": "self",
"href": "https://123.123.123.123:11005/api/v1/cloudInfrastructure/regions/226fd676-b501-445c-9f48-77b6f456b2f8/zones"
}
]
},
{"id": "f7b11b78-28a3-499f-b989-e6ad941d23ae",
"name": "eu-central-1",
"_links": [{"method": "GET",
"rel": "self",
"href": "https://123.123.123.123:11005/api/v1/cloudInfrastructure/regions/f7b11b78-28a3-499f-b989-e6ad941d23ae"
},
{"method": "GET",
"rel": "self",
"href": "https://123.123.123.123:11005/api/v1/cloudInfrastructure/regions/f7b11b78-28a3-499f-b989-e6ad941d23ae/zones"
}
]
}
],
"_links": [{"method": "GET",
"rel": "self",
"href": "https://123.123.123.123:11005/api/v1/cloudInfrastructure/regions"
}
]
}

Get AWS Region Data

The HTTP GET request to the /regions/{regionId} endpoint retrieves information on an AWS Region with the specified ID.

SecurityBearer

Request

path Parameters

regionId

required

string <uuid>

Specifies the system ID assigned to an AWS Region 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

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/cloudInfrastructure/regions/{regionId}

Request samples

curl
Python
JavaScript
C#
Go

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

Response samples

{"id": "226fd676-b501-445c-9f48-77b6f456b2f8",
"name": "af-south-1",
"_links": [{"method": "GET",
"rel": "self",
"href": "https://123.123.123.123:11005/api/v1/cloudInfrastructure/regions/226fd676-b501-445c-9f48-77b6f456b2f8"
},
{"method": "GET",
"rel": "self",
"href": "https://123.123.123.123:11005/api/v1/cloudInfrastructure/regions/226fd676-b501-445c-9f48-77b6f456b2f8/zones"
}
]
}

Get AWS Region Availability Zones

The HTTP GET request to the /regions/{regionId}/zones endpoint retrieves a list of Availability Zones of an AWS Region with the specified ID.

SecurityBearer

Request

path Parameters

regionId

required

string <uuid>

Specifies the system ID assigned to an AWS Region 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.
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.
Sort	Array of strings (RegionsSortColumns) 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"

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/cloudInfrastructure/regions/{regionId}/zones

Request samples

curl
Python
JavaScript
C#
Go

curl -i -X GET \
  'https://helpcenter.veeam.com/api/v1/cloudInfrastructure/regions/{regionId}/zones?SearchPattern=string&Offset=0&Limit=0&Sort=nameAsc' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'x-api-version: 1.7-rev0'

Response samples

{"totalCount": 4,
"results": [{"id": "448b1780-3eca-4fff-9354-0d854621645b",
"name": "us-west-2a",
"_links": [{"method": "GET",
"rel": "self",
"href": "https://123.123.123.123:11005/api/v1/cloudInfrastructure/regions/448b1780-3eca-4fff-9354-0d854621645b"
},
{"method": "GET",
"rel": "self",
"href": "https://123.123.123.123:11005/api/v1/cloudInfrastructure/regions/448b1780-3eca-4fff-9354-0d854621645b/zones"
}
]
},
{"id": "c711224c-443b-4c91-a846-6022e1fd79a2",
"name": "us-west-2b",
"_links": [{"method": "GET",
"rel": "self",
"href": "https://123.123.123.123:11005/api/v1/cloudInfrastructure/regions/c711224c-443b-4c91-a846-6022e1fd79a2"
},
{"method": "GET",
"rel": "self",
"href": "https://123.123.123.123:11005/api/v1/cloudInfrastructure/regions/c711224c-443b-4c91-a846-6022e1fd79a2/zones"
}
]
},
{"id": "e02c2764-da74-4765-bc30-4ec88c07f79d",
"name": "us-west-2c",
"_links": [{"method": "GET",
"rel": "self",
"href": "https://123.123.123.123:11005/api/v1/cloudInfrastructure/regions/e02c2764-da74-4765-bc30-4ec88c07f79d"
},
{"method": "GET",
"rel": "self",
"href": "https://123.123.123.123:11005/api/v1/cloudInfrastructure/regions/e02c2764-da74-4765-bc30-4ec88c07f79d/zones"
}
]
},
{"id": "ce9a6f0f-d1b0-4b23-b8e2-aba402528ee2",
"name": "us-west-2d",
"_links": [{"method": "GET",
"rel": "self",
"href": "https://123.123.123.123:11005/api/v1/cloudInfrastructure/regions/ce9a6f0f-d1b0-4b23-b8e2-aba402528ee2"
},
{"method": "GET",
"rel": "self",
"href": "https://123.123.123.123:11005/api/v1/cloudInfrastructure/regions/ce9a6f0f-d1b0-4b23-b8e2-aba402528ee2/zones"
}
]
}
],
"_links": [{"method": "GET",
"rel": "self",
"href": "https://123.123.123.123:11005/api/v1/cloudInfrastructure/regions/9795e709-ab15-4498-894d-1a2dd766b4db/zones"
}
]
}

Get Instance Types Available in AWS Region

The HTTP GET request to the /regions/{regionId}/instancesTypes endpoint retrieves a list of types of instances available in an AWS Region with the specified ID.

SecurityBearer

Request

path Parameters

regionId

required

string <uuid>

Specifies the system ID assigned to an AWS Region 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.
isArm64	boolean Returns only EC2 instances powered by Arm-based AWS Graviton Processor. For more information, see the Veeam Backup for AWS REST API Reference Overview, section Filter Parameter.
virtualizationTypes	Array of strings Returns only EC2 instances with the specified AMI virtualization type. For more information, see the Veeam Backup for AWS REST API Reference Overview, section Filter Parameter.

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/cloudInfrastructure/regions/{regionId}/instancesTypes

Request samples

curl
Python
JavaScript
C#
Go

curl -i -X GET \
  'https://helpcenter.veeam.com/api/v1/cloudInfrastructure/regions/{regionId}/instancesTypes?offset=0&limit=0&isArm64=true&virtualizationTypes=string' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'x-api-version: 1.7-rev0'

Response samples

No sample