Get a Company

In this article

    You can get a representation of a company with the specified ID or instanceUid.

    Request

    To get a resource representation of a company, send the GET HTTPS request to the URL of its resource.

    HTTP Request

    GET https://<hostname>:1281/v2/tenants/{ID}

    or

    GET https://<hostname>:1281/v2/tenants/{instanceUid}

    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/{ID} or /tenants/{instanceUid} resource.

    Example Get a Company

    The following example returns an entity representation of a company with ID 2.

    Request:

    GET https://localhost:1281/v2/tenants/2

     

    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",
       "backupProtectionEnabled": false,

       "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"

         }

       }

     },