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

Getting Tenant Properties by Tenant ID

This section explains how to get a list with properties for the specified tenant,

Request

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

Request Headers

The request header must contain an authorization token of the current session.

Request Parameters

The following parameters must be posted as URL.

Parameter	Description
tenantId	The identification numbers of the tenant. Can be obtained as described in Getting Tenants.

Request Body

None.

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 HTTPS headers.

Header	Description
Content-length	The length of the response body.
Content-type	The media type and syntax of the response body message: application/json; charset=utf-8

Response Body

Property	Type	Description
tenantId	integer	Shows the identification number of the tenant.
name	string	Shows the of the tenant.

Example

Request:

GET https://abc.ukwest.cloudapp.azure.com/api/v1/cloudInfrastructure/tenants/3e924ba9-93bc-40d5-8a47-33f07b239a52

Request Header:

Authorization: Bearer <Access-Token>

Response:

200 OK

Response Body:

{

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

"name": "Veeam Software Group GmbH"

}