This is an archive version of the document. To get the most up-to-date information, see the current version.Get Companies
You can get a representation of a collection of all companies in Veeam Service Provider Console.
Request
To get all companies managed in Veeam Service Provider Console, send the GET HTTPS request to the URL of the /tenants collection.
HTTP Request
GET https://<hostname>:1281/v2/tenants |
Request Headers
The request header must contain the authorization token for the current logon session.
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 representation of the /tenants collection.
Example 
The following example returns all companies managed in Veeam Service Provider Console.
Request: GET https://localhost:1281/v2/tenants
Request Header: Authorization: Bearer <Access-Token>
Response Code: 200 Success
Response Body: [ { "id": 2, "name": "Delta", "instanceUid": "b3ffc78b-7982-44f3-ae66-1384415f2bea", "cloudConnectAgentUid": "530a98c4-9489-4c45-973a-2e1281455a6a", "siteName": "AlphaSite", "vcdOrganizationUid": "0e70623c-9389-4019-940f-f1a48b158d3b", "tenantType": "General", "description": "Delta company account", "title": "Mr", "firstName": "John", "lastName": "Smith", "userName": "Delta", "emailAddress": "j.smith@delta.com", "isEnabled": true, "taxId": "147852369", "telephone": "8138318954", "country": "Canada", "city": "Calgary", "street": "16 Ave NW", "usState": null, "zipCode": "T3B 0N2", "domain": "delta.com", "companyId": "delta", "notes": "Gold SLA", "backupProtectionPeriod": 1, "networkFailoverResourcesEnabled": false, "numberOfPublicIp": 0, "publicIpEnabled": false, "maxConcurrentTasks": 5, "bandwidthThrottlingEnabled": false, "allowedBandwidth": 10, "allowedBandwidthUnits": "MB/s", "gatewayPools": [], "gatewayFailoverEnabled": false, "vMsBackedUp": 15, "vMsReplicated": 9, "vMsBackedUpToCloud": 26, "managedPhysicalWorkstations": 146, "managedCloudWorkstations": 5, "managedPhysicalServers": 21, "managedCloudServers": 4, "expirationEnabled": false, "expirationDate": null, "actions": [ "enable", "disable", "sendWelcomeLetter" ], "_links": { "self": { "href": "https://vac.tech.local:1281/v2/tenants/2" }, "backupResources": [ { "href": "https://vac.tech.local:1281/v2/tenants/2/backupresources/1" } ], "locations": [ { "href": "https://vac.tech.local:1281/v2/tenants/2/locations/2" } ], "replicaResources": [ { "href": "https://vac.tech.local:1281/v2/tenants/2/replicaResources/467667f2-bc1a-4593-9659-804fd46875e9" } ], "users": [ { "href": "https://vac.tech.local:1281/v2/users/2" } ], "subscriptionPlans": { "href": "https://vac.tech.local:1281/v2/subscriptionPlans/0" } } }, { "id": 8, "name": "Gamma", "instanceUid": "8b45e2b4-c947-497c-b751-4c4d58cf28fe", "cloudConnectAgentUid": "16883f4a-f7ff-4024-a62f-33e129aa96cf", "siteName": "SigmaSite", "vcdOrganizationUid": "faaaaa32-35f4-431a-a57b-f7e42b6c2de9", "tenantType": "General", "description": "Gamma company account", "title": "Ms", "firstName": "Brandy", "lastName": "Chavez", "userName": "Gamma", "emailAddress": "brandychavez@gamma.com", "isEnabled": true, "taxId": "345276067", "telephone": "(679)-565-8688", "country": "New Zealand", "city": "Auckland", "street": "Clarence Street", "usState": null, "zipCode": "37870", "domain": "gamma.com", "companyId": "gamma", "notes": "", "backupProtectionEnabled": false, "backupProtectionPeriod": 1, "networkFailoverResourcesEnabled": false, "numberOfPublicIp": 0, "publicIpEnabled": false, "maxConcurrentTasks": 1, "bandwidthThrottlingEnabled": false, "allowedBandwidth": 1, "allowedBandwidthUnits": "MB/s", "gatewayPools": [ { "instanceUid": "470be2bb-0dfb-41fd-8df7-92f6b2f26915", "name": "Cloud gateway pool Gold", "numberOfGateways": 1, "cloudAgentUid": "1f640d3b-0f87-49cf-bf61-f0e0e237af76", "_links": null } ], "gatewayFailoverEnabled": false, "vMsBackedUp": 0, "vMsReplicated": 0, "vMsBackedUpToCloud": 0, "managedPhysicalWorkstations": 0, "managedCloudWorkstations": 0, "managedPhysicalServers": 0, "managedCloudServers": 0, "expirationEnabled": false, "expirationDate": null, "actions": [ "enable", "disable", "sendWelcomeLetter" ], "_links": { "self": { "href": "https://vac.tech.local:1281/v2/tenants/8" }, "backupResources": [ { "href": "https://vac.tech.local:1281/v2/tenants/8/backupresources/2" } ], "locations": [ { "href": "https://vac.tech.local:1281/v2/tenants/8/locations/5" } ], "replicaResources": [ { "href": "https://vac.tech.local:1281/v2/tenants/8/replicaResources/7afe45fd-33f5-44fd-a410-c7e1048237b9" } ], "users": [ { "href": "https://vac.tech.local:1281/v2/users/4" } ], "subscriptionPlans": { "href": "https://vac.tech.local:1281/v2/subscriptionPlans/5" } } }, ] |