Getting License Information

In this article

    You can get licensing information for an organization with the specified ID.

    Request

    GET https://<hostname>:4443/v5/Organizations/{organizationId}/LicensingInformation

    Request Headers

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

    Request Parameters

    The following parameter must be specified in the URL of the request.

    Parameter

    Type

    Description

    organizationId

    string

    An identification number of the organization.

    Request Body

    None.

    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

    Property

    Type

    Description

    licensedUsers

    integer

    Specifies the amount of the used licenses.

    newUsers

    integer

    Veeam Backup for Microsoft Office 365 can temporarily provide you with additional 10% of the total licence amount for new employees joining your organization. When the number of used licenses exceeds the limit, you will still be able to perform backup and recovery operations. This property specifies how many extra licenses are in use at the moment.

    Examples

    Example 1

    The following request returns a resource representation of the licensing information for an organization with the specified ID.

    Request:

    GET https://abc.tech.local:4443/v5/Organizations/92460656-7a85-4a04-b1af-1ea903c0bc2e/LicensingInformation

     

    Request Header:

    Authorization: Bearer <Access-Token>

     

    Response:

    200 OK

     

    Response Body:

    [

     {

     "licensedUsers": 0,

     "newUsers": 0

    }

    I want to report a typo

    There is a misspelling right here:

     

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