Get All Subtenants Registered on Site
You can get a collection resource representation of all subtenants provided with resources of a site with the specified UID.
Required Privileges
To perform this task, a user must have one of the following roles assigned: Portal Administrator, Service Provider Global Administrator, Service Provider Administrator.
Request
To get a representation of all subtenants provided with resources of a specific site, send the GET HTTP request to the URL of the /infrastructure/sites/{siteUid}/tenants/subtenants collection.
HTTP Request
GET https://<hostname>:1280/api/v3/infrastructure/sites/{siteUid}/tenants/subtenants |
Request Headers
The request contains the following headers.
Header | Required/Optional | 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. |
Accept | Optional | application/json | Specifies a media type of representation that is required in the response message. If the requested type is not supported, the server will return the response in the application/json media type. |
Request parameters
A list of parameters that are applicable for this operation:
Name | In | Type | Required | Default | Description |
|---|---|---|---|---|---|
siteUid | Path | String (uuid) | Yes | — | Site UID |
limit | Query | Integer (int32) | No | 100 | Specifies the first N resources that must be returned in the output |
offset | Query | Integer (int32) | No | 0 | Excludes the first N resources from the query output |
Response
The server returns the following response to the client.
Response Code
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: application/json; charset=utf-8 |
Response Body
In the response body, Veeam Service Provider Console returns a collection resource representation based on the CloudSubTenant schema.
Example 
The following request returns a representation of all subtenants provided with resources of a site with UID 365ce228-b14d-421a-9a0e-a1a434e2195c.
Request: GET https://localhost:1280/api/v3/infrastructure/sites/365ce228-b14d-421a-9a0e-a1a434e2195c/tenants/subtenants
Request Header: Authorization: Bearer <Access-Token>
Response Code: 200 OK
Response Body: { "meta": { "pagingInfo": { "total": 2, "count": 2, "offset": 0 } }, "data": [ { "instanceUid": "9e0cbafe-2b09-4707-be63-56d1a75da903", "tenantUid": "b4971992-84ac-4dee-b837-95c2db286f28", "name": "AlphaCompanySubtenant", "description": "Created by Veeam Service Provider Console 3/27/2020 5:31:08 PM", "backupServerUid": "365ce228-b14d-421a-9a0e-a1a434e2195c", "isEnabled": true }, { "instanceUid": "4685e335-b018-4fe1-8cc6-c04cffce7fc8", "tenantUid": "596f9b5b-7360-4372-8934-fdd7dd81b98c", "name": "BetaCompanySubtenant", "description": "Created by Veeam Service Provider Console 3/30/2020 2:11:34 PM", "backupServerUid": "365ce228-b14d-421a-9a0e-a1a434e2195c", "isEnabled": true } ] } |
