Get Tenant Data

You can get data on a tenant with the specified ID.

Request

To retrieve information on a specific tenant, send the HTTP GET request to the /cloudInfrastructure/tenants/{tenantId} endpoint. {tenantId} is a system ID assigned to the tenant in the Veeam Backup for Microsoft Azure REST API.

HTTP Request

GET https://<hostname>/api/v2/cloudInfrastructure/tenants/{tenantId}

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 representation of the tenant with the specified ID.

Get Tenant DataExample

The following request returns information on a tenant with the ID 3e924ba9-93bc-40d5-8a47-33f07b239a52.

Request:

GET https://51.11.247.127/api/v2/cloudInfrastructure/tenants/3e924ba9-93bc-40d5-8a47-33f07b239a52

 

Request Header:

Authorization: Bearer <Access-Token>

 

Response:

200

 

Response Body:

{

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

 "name": "Veeam Software Group GmbH"

}

I want to report a typo

There is a misspelling right here:

 

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