This is an archive version of the document. To get the most up-to-date information, see the current version.Get AWS Regions Selected for Backup Policy
You can get AWS regions selected for a backup policy with the specified ID.
Request
To a list of AWS regions, send the HTTP GET request to the /policies/{policyId}/regions endpoint. {policyId} is a system ID assigned to the backup policy in the Veeam Backup for AWS REST API.
HTTP Request
GET https://<hostname>:<port>/api/v1/policies/{policyId}/regions |
Query Parameters
To control the amount and order of data in the response, you can use Offset, Limit, SearchPattern and the following query parameters:
Query Parameter | Value | Description |
|---|---|---|
Sort |
| Specifies the order of items in the response. For more information, see Sort Parameter. |
Request Headers
The request contains the following headers.
Header | Required/Optional | Value | Description |
|---|---|---|---|
Authorization | Required | Bearer <Access-Token> | Authenticates a client who sends the request to the server. Must contain the access token for the current logon session in the Bearer <Access-Token> format. |
x-api-version | Required | 1.0-rev0 | Specifies the current revision of the Veeam Backup for AWS REST API. |
Accept | Optional |
| Specifies a media type of representation that is required in the response message. If the requested type is not supported, the server will return the response in the application/json media type. |
Response
The server returns the following response to the client.
Response Code
A successfully completed operation returns a response code 200 (OK).
Response Headers
The response to this request contains the following headers. The response may also include additional standard HTTP headers.
Header | Value | Description |
|---|---|---|
Content-Length | integer | Identifies the length of the response body message, in bytes. |
Content-Type |
| Identifies the media type of the response body message. |
Response Body
In the response body, Veeam Backup for AWS returns a list of AWS regions selected for the backup policy with the specified ID. The Region schema is used for the collection representation.
Example
The following request returns information on all AWS regions selected for a backup policy with the ID 6ac40b80-4bdb-46e9-9759-0fc0d1166ccf.
|