This is an archive version of the document. To get the most up-to-date information, see the current version.

Get AWS Region Network Settings

You can get network settings configured for a specific Availability Zone of an AWS region used to launch worker instances.

Request

To retrieve a representation of network settings of a specific Availability Zone, send the HTTP GET 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

GET 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.

Accept

Optional

  • application/json
  • application/problem+json

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

  • application/json
  • application/problem+json

Identifies the media type of the response body message.

Response Body

In the response body, Veeam Backup for AWS returns a representation of the Availability Zone network settings. The RegionSettings schema is used for the resource representation.

Get AWS Region Network SettingsExample

The following request returns network settings of an Availability Zone with the ID f7b11b78-28a3-499f-b989-e6ad941d23ae.

Request:

GET https://135.169.170.192:11005/api/v1/settings/regions/f7b11b78-28a3-499f-b989-e6ad941d23ae

 

Request Header:

Authorization: Bearer <Access-Token>

x-api-version: 1.0-rev0

 

Response:

200

 

Response Body:

   {

     "regionId": "f7b11b78-28a3-499f-b989-e6ad941d23ae",

     "regionName": "eu-central-1b",

     "parentReiognId": "b7ec414c-dff8-467a-8dd9-fa52e5d684f8",

     "parentRegionName": "EU (Frankfurt) (eu-central-1)",

     "cloudNetworkId": "vpc-66a3c80e",

     "cloudNetworkName": "Default (172.31.0.0/16)",

     "cloudSubnetworkId": "subnet-39671a43",

     "cloudSubnetworkName": "172.31.32.0/20 (eu-central-1b)",

     "cloudSecurityGroupId": "sg-056f236c9d4e788a7",

     "cloudSecurityGroupName": "Veeam Generic Access",

     "_links": [

       {

         "method": "GET",

         "rel": "self",

         "href": "https://135.169.170.192:11005/api/v1/settings/regions/f7b11b78-28a3-499f-b989-e6ad941d23ae"

       },

       {

         "method": "PUT",

         "rel": "update",

         "href": "https://135.169.170.192:11005/api/v1/settings/regions/f7b11b78-28a3-499f-b989-e6ad941d23ae"

       },

       {

         "method": "DELETE",

         "rel": "delete",

         "href": "https://135.169.170.192:11005/api/v1/settings/regions/f7b11b78-28a3-499f-b989-e6ad941d23ae"

       }