Generating License Overview Report

In this article

    You can generate license overview reports on the Veeam Backup for Microsoft 365 server.

    Request

    POST https://<hostname>:4443/v6/Reports/GenerateLicenseOverview

    Request Headers

    The request header must contain an authorization token of the current session.

    Request Body

    To generate the License Overview report, the request body must contain the following properties:

    Property

    Type

    Description

    startTime

    UTC

    Specifies date and time when the the reporting interval starts.

    endTime

    UTC

    Specifies date and time when the the reporting interval ends.

    format

    string

    Specifies the format in which to save a report. The following types are available:

    • PDF
    • CSV

    timezone

    string

    Specifies a time zone for the reporting interval. The following values are available:

    • Local
    • UTC
    • UTC+<HH:MM>

    For example: UTC+05:00.

    • UTC-<HH:MM>

    For example: UTC-11:30.

    If you do not specify this property, the server will generate a report for the UTC time zone.

    For example:

    Request Body:

    {

     "startTime": "2022-02-03T19:21:24.912Z",

     "endTime": "2022-03-03T19:21:24.912Z",

     "format": "PDF",

     "timezone": "UTC"

    }

    Response

    The server returns the following response to the client.

    Response Codes

    A successfully completed operation returns a response code 200 OK.

    Response Headers

    The response to this request contains the following headers. The response may also include additional standard HTTPS headers.

    Header

    Description

    Content-length

    The length of the response body.

    Content-type

    The media type and syntax of the response body message: application/json; charset=utf-8

    Response Body

    None.

    Example

    The example shows how to generate the License Overview report.

    Request:

    POST https://abc.tech.local:4443/v6/Reports/GenerateLicenseOverview

     

    Request Header:

    Authorization: Bearer <Access-Token>

     

    Request Body:

    {

     "startTime": "2022-02-03T19:21:24.912Z",

     "endTime": "2022-03-03T19:21:24.912Z",

     "format": "PDF",

     "timezone": "UTC"

    }

     

    Response:

    200 OK