This is an archive version of the document. To get the most up-to-date information, see the current version.Get Tenant
You can get a resource representation of a tenant 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 resource representation of a tenant, send the GET HTTP request to the URL of the /infrastructure/sites/tenants/{tenantUid} resource.
HTTP Request
GET https://<hostname>:1280/api/v3/infrastructure/sites/tenants/{tenantUid} |
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 | Constraints | Description |
|---|---|---|---|---|---|---|
tenantUid | Path | String (uuid) | Yes | — | — | Tenant UID |
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 resource representation based on the CloudTenant schema.
Example 
The following request returns a representation of a tenant with UID c386d34c-0ab6-4e13-b30a-67fcb05b83e4.
Request: GET https://localhost:1280/api/v3/infrastructure/sites/tenants/c386d34c-0ab6-4e13-b30a-67fcb05b83e4
Request Header: Authorization: Bearer <Access-Token>
Response Code: 200 OK
Response Body: { "data": { "instanceUid": "c386d34c-0ab6-4e13-b30a-67fcb05b83e4", "name": "Alpha", "description": "Alpha Tenant", "hashedPassword": null, "type": "general", "backupServerUid": "3b5be228-b14d-421a-9a0e-a1a434e2195c", "gatewaySelectionType": "gatewayPool", "isEnabled": true, "isLeaseExpirationEnabled": false, "leaseExpirationDate": null, "isBackupProtectionEnabled": false, "backupProtectionPeriod": null, "isGatewayFailoverEnabled": false, "gatewayPoolsUids": [ "e1135752-d497-43e0-8857-8a0c3a262e2e" ], "isThrottlingEnabled": false, "throttlingValue": null, "throttlingUnit": null, "maxConcurrentTask": 1, "isBackupResourcesEnabled": false, "isNativeReplicationResourcesEnabled": true, "isVcdReplicationResourcesEnabled": false } } |