Get Azure Regions Selected for Backup Policy

You can get Azure regions selected for a backup policy with the specified ID.

Request

To retrieve a list of Azure 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 Microsoft Azure REST API.

HTTP Request

GET https://<hostname>/api/v2/policies/{policyId}/regions

Query Parameters

To control the amount and order of data in the response, you can use Offset, Limit query parameters.

Request Headers

The request contains the following headers.

Header

Required

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.

Response

The server returns the following response to the client.

Response Codes

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 Microsoft Azure returns a list of Azure regions selected for the backup policy with the specified ID. The PolicyV2 schema is used for the collection representation.

Get Azure Regions Selected for Backup PolicyExample

The following request returns information on all Azure regions selected for a backup policy with the ID 6ac40b80-4bdb-46e9-9759-0fc0d1166ccf.

Request:

GET https://51.11.247.127/api/v2/policies/6ac40b80-4bdb-46e9-9759-0fc0d1166ccf/regions

 

Request Header:

Authorization: Bearer <Access-Token>

 

Response:

200

 

Response Body:

{

 "offset": 0,

 "limit": 200,

 "totalCount": 1,

 "results": [

   {

     "id": "ukwest",

     "name": "UK West",

     "_embeddedResources": {

       "subscriptions": [

         {

           "id": "1142bdc7-8797-42bc-aa23-9f1fc1411946",

           "environment": "Global",

           "tenantId": "3e924ba9-93bc-40d5-8a47-33f07b239a52",

           "tenantName": "Veeam Software Group GmbH",

           "status": "Active",

           "_links": {}

         },

         {

           "id": "3a9a4930-7bbc-4b83-9c68-15d674fbc803",

           "environment": "Global",

           "tenantId": "3e924ba9-93bc-40d5-8a47-33f07b239a52",

           "tenantName": "Veeam Software Group GmbH",

           "status": "Active",

           "_links": {}

         }

       ]

     }

   }

 ],

 "_links": {

   "self": {

     "href": "https://51.11.247.127/api/v2/policies/a1c3b4cb-29d4-4615-b4d8-d1e1b7f3bf55/regions?offset=0&limit=200"

   }

 }

}

I want to report a typo

There is a misspelling right here:

 

I want to let the Veeam Documentation Team know about that.