This is an archive version of the document. To get the most up-to-date information, see the current version.Modify AWS Region Network Settings
You can update network settings for a specific Availability Zone of an AWS region used to launch worker instances..
Request
To change Availability Zone network settings, send the HTTP PUT request to the /settings/regions/{regionId} endpoint. {regionId} is a system ID assigned to the Availability Zone of the AWS region in the Veeam Backup for AWS REST API.
HTTP Request
PUT https://<hostname>:<port>/api/v1/settings/regions/{regionId} |
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 update Availability Zone network settings, send the RegionSettings schema in the request body. The following parameters are required.
Parameter | Type | Description |
|---|---|---|
regionId | 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. |
Set the parameter values in the following format:
{ "regionId": "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 an updated representation of the Availability Zone network settings. The RegionSettings schema is used for the resource representation.
Example
The following request updates security group settings for an Availability Zone with the ID f27b37dd-e243-42c3-a4ec-8b2ba3988a3d.
|