Backup Vaults

The /backupVaults resource collection represents all AWS backup vaults created in AWS Regions and available to Veeam Backup for AWS.

Get Collection of Backup Vaults

The HTTP GET request to the /backupVaults endpoint retrieves a list of all backup vaults available to Veeam Backup for AWS.

SecurityBearer

Request

query Parameters

Id	string <uuid> Returns information on a backup vault with the specified ID.
RegionId	string <uuid> Returns backup vaults of an AWS Region with the specified ID.
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 (BackupVaultsSortColumns) 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" "regionNameAsc" "regionNameDesc" "isEncryptedAsc" "isEncryptedDesc"

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

Request samples

curl
Python
JavaScript
C#
Go

curl -i -X GET \
  'https://helpcenter.veeam.com/api/v1/backupVaults?Id=497f6eca-6276-4993-bfeb-53cbbbba6f08&RegionId=497f6eca-6276-4993-bfeb-53cbbbba6f08&SearchPattern=string&Offset=0&Limit=0&Sort=nameAsc' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'x-api-version: 1.7-rev0'

Response samples

application/json

{"totalCount": 0,
"results": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"isDeleted": true,
"region": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string"
},
"awsResourceId": "string",
"isEncrypted": true,
"_links": [{"rel": "string",
"href": "string",
"method": "GET"
}
]
}
],
"_links": [{"rel": "string",
"href": "string",
"method": "GET"
}
]
}