Help Center
Choose product document...
Veeam Backup & Replication 9.5
RESTful API Reference

(GET) /cloud/tenants/{ID}/subtenants/{ID}

Returns a resource representation of the subtennat account with the specified ID created for the tenant account with the specified ID.

Request

To get a resource representation of the subtenant account, you need to send the GET HTTP request to the URL of the /cloud/tenants/{ID}/subtenants/{ID} resource:

HTTP Request

GET http://<Enterprise-Manager>:9399/api/cloud/tenants/{ID}/subtenants/{ID}

Request Headers

The request contains the following headers:

Header

Required

Description

X-RestSvcSessionId

True

The request requires authorization. In the header, the client must send a session ID copied from the server reply to the request creating a new logon session. To learn more, see Authentication and Security.

Request Body

None.

Query Parameters

The following parameters can be used in queries.

Parameter

Type

Description

Can Be Used for Filtering

Can Be Used for Sorting

Uid

String

ID of the subtenant account resource, for example: 4da30260-581d-4b94-8a56-61c117819dcc.

True

True

Name

String

Name of the subtenant account, for example: ABC Company PC User.

True

True

CloudTenantUid

URN

ID of the tenant account parent to the subtenant account resource, for example: urn:veeam:CloudTenant:65f1c495-1942-449b-8317-e877251d0822.

True

True

CloudTenantName

String

Name of the tenant account parent to the subtenant account resource, for example: ABC Company.

True

True

Disabled

Boolean

Defines whether the subtenant account is in the disabled or enabled state. Possible values:

  • True — the subtenant account is disabled
  • False - the subtenant account is enabled

True

True

Unlimited

Boolean

Defines whether the storage quota assigned to the subtenant account is unlimited. Possible values:

  • True — the subtenant quota is not limited. The subtenant can use all storage space available within the tenant quota.
  • False — the subtenant quota is limited.

True

True

Quota

Int

Size of the storage quota assigned to the subtenant account (in MB).

True

True

UsedQuota

Int

Amount of used space within the storage quota assigned to the subtenant account (in MB).

True

True

BackupResourceId

String

ID of the tenant storage quota on which the storage quota for the subtenant account is created, for example: 11c59670-23df-448c-a4b3-74c42669633e.

True

True

BackupServerUID

URN

ID of the Veeam backup server parent to the subtenant account resource.

True

True

BackupServerName

String

Name of the Veeam backup server parent to the subtenant account resource.

True

True

Response

The server returns the following response to the client.

Response Codes

A successfully completed operation returns response code 200 Success.

Response Headers

The response to this request contains the following headers. The response may also include additional standard HTTP headers.

Header

Description

Content-length

The length of the response body.

Content-type

The media type and syntax of the request body message: application/xml.

Response Body

In the response body, Veeam Backup Enterprise Manager returns a representation of the /cloud/tenants/{ID}/subtenants/{ID} resource.

Example

The example below returns an entity representation of the subtenant account with ID 0eb0c130-d91a-4e05-9403-ac2ded0fc1ea. The subtenant account was created for the tenant account with ID 28ddf9b9-12fa-431a-a34c-a327f05c3920.

Request:

GET http://localhost:9399/api/cloud/tenants/28ddf9b9-12fa-431a-a34c-a327f05c3920/subtenants/0eb0c130-d91a-4e05-9403-ac2ded0fc1ea

 

Request Header:

X-RestSvcSessionId   NDRjZmJkYmUtNWE5NS00MTU2LTg4NjctOTFmMDY5YjdjMmNj

 

Response:

200 Success

 

Response Body:

<CloudSubtenant xmlns="http://www.veeam.com/ent/v1.0" Type="CloudSubtenant" Href="http://localhost:9399/api/cloud/tenants/28ddf9b9-12fa-431a-a34c-a327f05c3920/subtenants/0eb0c130-d91a-4e05-9403-ac2ded0fc1ea" Id="0eb0c130-d91a-4e05-9403-ac2ded0fc1ea">
 <Links>
   <Link Rel="Edit" Type="CloudSubtenant" Href="http://localhost:9399/api/cloud/tenants/28ddf9b9-12fa-431a-a34c-a327f05c3920/subtenants/0eb0c130-d91a-4e05-9403-ac2ded0fc1ea" Name="ABC Company User 01" />
   <Link Rel="Delete" Href="http://localhost:9399/api/cloud/tenants/28ddf9b9-12fa-431a-a34c-a327f05c3920/subtenants/0eb0c130-d91a-4e05-9403-ac2ded0fc1ea" />
   <Link Rel="Up" Type="CloudTenant" Href="http://localhost:9399/api/cloud/tenants/28ddf9b9-12fa-431a-a34c-a327f05c3920?format=Entity" Name="ABC Company" />
   <Link Rel="Up" Type="BackupServer" Href="http://localhost:9399/api/backupServers/1cf4ea89-89d9-4b4e-a285-71bd8c705222?format=Entity" Name="172.17.53.2" />
 </Links>
 <Name>ABC Company User 01</Name>
 <Description>ABC Company PC User</Description>
 <Password />
 <Enabled>true</Enabled>
 <RepositoryQuota Unlimited="true">
   <DisplayName>Cloud Vol User 01</DisplayName>
   <TenantResourceId>11c59670-23df-448c-a4b3-74c42669633e</TenantResourceId>
   <QuotaMb>20480</QuotaMb>
   <UsedQuotaMb>0</UsedQuotaMb>
 </RepositoryQuota>
</CloudSubtenant>

 

Veeam Large Logo

User Guide for VMware vSphere

User Guide for Microsoft Hyper-V

Enterprise Manager User Guide

Veeam Cloud Connect Guide

Veeam Backup Explorers User Guide

PowerShell Reference

RESTful API Reference

Veeam Backup FREE Edition User Guide

Veeam Backup for Microsoft Office 365

Veeam ONE Documentation

Veeam Endpoint Backup Documentation

Veeam Management Pack Documentation