This is an archive version of the document. To get the most up-to-date information, see the
current version.
(GET) /cloud/tenants
Returns a resource representation of a collection of tenant accounts created on all Veeam Backup Servers connected to Veeam Backup Enterprise Manager.
To get a list of tenant accounts, you need to send the GET HTTP request to the URL of the /cloud/tenants resource.
HTTP Request
GET http://<Enterprise-Manager>:9399/api/cloud/tenants |
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
None.
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 resource collection.
The example below returns a list of tenant accounts created on all Veeam backup servers that are currently connected to Veeam Backup Enterprise Manager.
Request: GET http://localhost:9399/api/cloud/tenants Request Header: X-RestSvcSessionId NDRjZmJkYmUtNWE5NS00MTU2LTg4NjctOTFmMDY5YjdjMmNj Response: 200 Success Response Body: <EntityReferences xmlns="http://www.veeam.com/ent/v1.0">
<Ref Type="CloudTenantReference" Href="http://localhost:9399/api/cloud/tenants/b3ed42c9-3022-4958-864f-3df32e8436f9" Name="UCM Company" UID="urn:veeam:CloudTenant:b3ed42c9-3022-4958-864f-3df32e8436f9">
<Links>
<Link Rel="Up" Type="BackupServerReference" Href="http://localhost:9399/api/backupServers/8ea5406b-a6e9-42d9-bca5-44b6a5d94af1" Name="localhost" />
<Link Rel="Alternate" Type="CloudTenant" Href="http://localhost:9399/api/cloud/tenants/b3ed42c9-3022-4958-864f-3df32e8436f9?format=Entity" Name="UCM Company" />
</Links>
</Ref>
<Ref Type="CloudTenantReference" Href="http://localhost:9399/api/cloud/tenants/9e76e394-9dfe-4089-bc0d-569c5376ae86" Name="Applied Systems Company" UID="urn:veeam:CloudTenant:9e76e394-9dfe-4089-bc0d-569c5376ae86">
<Links>
<Link Rel="Up" Type="BackupServerReference" Href="http://localhost:9399/api/backupServers/8ea5406b-a6e9-42d9-bca5-44b6a5d94af1" Name="localhost" />
<Link Rel="Alternate" Type="CloudTenant" Href="http://localhost:9399/api/cloud/tenants/9e76e394-9dfe-4089-bc0d-569c5376ae86?format=Entity" Name="Applied Systems Company" />
</Links>
</Ref>
<Ref Type="CloudTenantReference" Href="http://localhost:9399/api/cloud/tenants/4f90635a-7ecc-49fe-beb6-60b37eb4bd89" Name="ABC Company" UID="urn:veeam:CloudTenant:4f90635a-7ecc-49fe-beb6-60b37eb4bd89">
<Links>
<Link Rel="Up" Type="BackupServerReference" Href="http://localhost:9399/api/backupServers/8ea5406b-a6e9-42d9-bca5-44b6a5d94af1" Name="localhost" />
<Link Rel="Alternate" Type="CloudTenant" Href="http://localhost:9399/api/cloud/tenants/4f90635a-7ecc-49fe-beb6-60b37eb4bd89?format=Entity" Name="ABC Company" />
</Links>
</Ref>
<Ref Type="CloudTenantReference" Href="http://localhost:9399/api/cloud/tenants/20602b2b-d55b-436c-9010-b4c7046c294a" Name="Tri-M Company" UID="urn:veeam:CloudTenant:20602b2b-d55b-436c-9010-b4c7046c294a">
<Links>
<Link Rel="Up" Type="BackupServerReference" Href="http://localhost:9399/api/backupServers/8ea5406b-a6e9-42d9-bca5-44b6a5d94af1" Name="localhost" />
<Link Rel="Alternate" Type="CloudTenant" Href="http://localhost:9399/api/cloud/tenants/20602b2b-d55b-436c-9010-b4c7046c294a?format=Entity" Name="Tri-M Company" />
</Links>
</Ref>
</EntityReferences> |
