This is an archive version of the document. To get the most up-to-date information, see the current version.Configure AWS Region Network Settings
You can configure network settings for an Availability Zone of an AWS region you plan to use for launching of worker instances.
Request
To configure an Availability Zone network settings, send the HTTP POST request to the /settings/regions endpoint.
HTTP Request
POST https://<hostname>:<port>/api/v1/settings/regions |
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. |
Content-Type | Required | application/json | Identifies a media type that is used in the body of the request. |
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. |
Request Body
To add the S3 repository, send the following parameters in the request body.
Parameter | Type | Description |
|---|---|---|
availableZoneId | string($uuid) | Specifies a system ID assigned in the Veeam Backup for AWS REST API to an Availability Zone of an AWS region where worker instances will be launched. For more information, see Get Amazon Connection Availability Zones. |
cloudNetworkId | string | Specifies an AWS ID of an Amazon VPC. For more information, see Get Amazon Connection VPC. |
cloudSubnetworkId | string | Specifies AWS ID of a subnet. For more information, see Get Amazon Connection Subnets. |
cloudSecurityGroupId | string | Specifies AWS ID of a security group. For more information, see Get Amazon Connection Security Groups. |
Note |
[For backup/restore operations to/from Amazon S3] Make sure that an S3 endpoint is configured for the selected subnet. Otherwise, you may be charged additional fee for the traffic from Amazon EC2 to Amazon S3. For more information on how to check whether the S3 endpoint is configured, see Validate S3 Endpoint. |
Set the parameter values in the following format:
{ "availableZoneId": "string($uuid)", "cloudNetworkId": "string", "cloudSubnetworkId": "string", "cloudSecurityGroupId": "string" } |
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 representation of the configured Availability Zone network settings. The RegionSettings schema is used for the resource representation.
Example
The following request configures network settings for an Availability Zone that where Veeam Backup for AWS will launch worker instances.
|