Get Tenant License Usage Report for Specific Date

You can get a representation of all license usage reports for a specific month.

Request

To get a representation of a license usage report for a specific month, send the GET HTTPS request to the URL of the /tenants/licensing/reports/{date} resource.

HTTP Request

GET https://<hostname>:1281/v2/tenants/licensing/reports/{date}

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 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/json; charset=utf-8

Response Body

In the response body, Veeam Service Provider Console returns a representation of the /tenants/licensing/reports/{date} resource.

Example Get Tenant License Usage Report for Specific Date

The following request returns representation of a license usage report for March.

Request:

GET https://localhost:1281/v2/tenants/licensing/reports/2020-03

 

Request Header:

Authorization: Bearer <Access-Token>

 

Response Code:

200 OK

 

Response Body:

[

 {

   "reportParemeters": {

     "reportId": 10,

     "organizationName": "Veeam Software AG",

     "organizationUid": "e312fbbd-1e33-415d-8d38-b422c576523a",

     "licenseCompanyName": "Veeam Software AG",

     "generationDate": "2020-04-11T00:00:00.0000000-07:00",

     "reportInterval": {

       "startOfInterval": "2020-03-01T00:00:00.0000000-08:00",

       "endOfInterval": "2020-03-31T00:00:00.0000000-07:00"

     }

   },

   "reportSummary": {

     "totalPoints": 5.0,

     "productsUsage": [

       {

         "productName": "backupAndReplication",

         "totalPoints": 5.0,

         "licenseEdition": "Standard",

         "workloadUsage": [

           {

             "workloadType": "vbR_VM",

             "initialCount": 2,

             "reportedCount": 1,

             "newCount": 0,

             "weight": 5.0,

             "usedPoints": 5.0

           }

         ]

       }

     ]

   },

   "organizationsUsage": [

     {

       "organizationType": "company",

       "organizationName": "Beta",

       "organizationUid": "e312fbbd-1e33-415d-8d38-b422c576523a",

       "tenantId": "cdb843a2-950d-47d0-bf81-b53cec59865b",

       "usedPoints": 5.0

     }

   ],

   "notCollectedCloudServers": null,

   "usageDetails": [

     {

       "organizationName": "Beta",

       "organizationUid": "e312fbbd-1e33-415d-8d38-b422c576523a",

       "tenantId": "cdb843a2-950d-47d0-bf81-b53cec59865b",

       "supportId": "01276360",

       "notCollectedClientServers": [],

       "usageByLicenseAndProduct": [

         {

           "licenseId": "11112222-1111-2222-3333-111122233333",

           "productName": "backupAndReplication",

           "licenseEdition": "Standard",

           "usedPoints": 5.0,

           "workloadUsage": [

             {

               "workloadType": "vbR_VM",

               "initialCount": 2,

               "reportedCount": 1,

               "newCount": 0,

               "weight": 5.0,

               "usedPoints": 5.0

             }

           ]

         },

         {

           "licenseId": "11112222-1111-2222-3333-111122233333",

           "productName": "vspc",

           "licenseEdition": "EnterprisePlus",

           "usedPoints": 0.0,

           "workloadUsage": [

             {

               "workloadType": "vaC_Workstation_Agent",

               "initialCount": 0,

               "reportedCount": 0,

               "newCount": 1,

               "weight": 4.0,

               "usedPoints": 0.0

             },

             {

               "workloadType": "vaC_Server_Agent",

               "initialCount": 0,

               "reportedCount": 0,

               "newCount": 1,

               "weight": 11.0,

               "usedPoints": 0.0

             }

           ]

         }

       ]

     }

   ],

   "appendices": []

 }

]

I want to report a typo

There is a misspelling right here:

 

I want to let the Veeam Documentation Team know about that.