Get Collection of Tenants

You can get a list of all tenants available for Azure accounts added to the Veeam Backup for Microsoft Azure configuration database.

Request

To retrieve a representation of a collection of tenants, send the HTTP GET request to the /cloudInfrastructure/tenants endpoint.

HTTP Request

GET https://<hostname>/api/v2/cloudInfrastructure/tenants

Query Parameters

To control the amount and order of data in the response, you can use Offset, Limit, SearchPattern and the following 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 202 (Accepted).

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 the operation ID with 202 Code. For the operation log details, see Get Operation Data.

Get Collection of TenantsExample

The following request runs retrieving operation for a list of tenants.

Request:

GET https://51.11.247.127/api/v2/cloudInfrastructure/tenants

 

Request Header:

Authorization: Bearer <Access-Token>

 

Response:

202

 

Response Body:

{

 "id": "d8d80139-2aca-4870-9bb8-b02701118fe4",

 "startTime": "2020-12-01T21:37:09.5885891Z",

 "status": "Running",

 "_links": {

   "self": {

     "href": "https://51.11.247.127/api/v2/operations/d8d80139-2aca-4870-9bb8-b02701118fe4"

   }

 }

}

I want to report a typo

There is a misspelling right here:

 

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