This is an archive version of the document. To get the most up-to-date information, see the current version.(GET) /cloud/tenants/{ID}/subtenants/{ID}
Returns a resource representation of the subtenat 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
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. |
Accept | False | Identifies the format of the response. Possible values:
If the request does not contain the header, the server will return the response in the XML format. |
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 | True |
Unlimited | Boolean | Defines whether the storage quota assigned to the subtenant account is unlimited. Possible values:
| 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 OK.
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. Possible values:
|
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 https://localhost:9398/api/cloud/tenants/28ddf9b9-12fa-431a-a34c-a327f05c3920/subtenants/0eb0c130-d91a-4e05-9403-ac2ded0fc1ea
Request Header: X-RestSvcSessionId NDRjZmJkYmUtNWE5NS00MTU2LTg4NjctOTFmMDY5YjdjMmNj
Response: 200 OK
Response Body: <CloudSubtenant xmlns="http://www.veeam.com/ent/v1.0" Type="CloudSubtenant" Href="https://localhost:9398/api/cloud/tenants/28ddf9b9-12fa-431a-a34c-a327f05c3920/subtenants/0eb0c130-d91a-4e05-9403-ac2ded0fc1ea" Id="0eb0c130-d91a-4e05-9403-ac2ded0fc1ea"> |
