Licensing

Display system’s licensing

GET /api/v1/system/licensing/

Retrieve the informations of the licensing of the system.

Example request:

GET /api/v1/system/licensing/ HTTP/1.1
Host: example.com

Example response:

HTTP/1.1 200 OK
Content-Type: "application/json"

{
      "licenseStrictness": "Hard",
      "maxUsersByGroup": 999999,
      "expirationDate": "2020-10-31 23:59:59 +0100",
      "hostId": [
                  "36910BB3-8A1F-051B-F6C3-647296BF50C0",
                  "919C9852-6515-392E-129F-7187F496357E"
      ],
      "licenseName": [
                      "Deployment Studio",
      ],
      "numberOfTrunkUsers": 196,
      "subscriberLicenses": [
                            {
                                "name": "User License",
                                "licensed": "100",
                                "used": "88",
                                "available": "12"
                            },
      ],
      "groupServiceLicenses": [
                              {
                                  "name": "6SYSGROUP",
                                  "licensed": "70",
                                  "used": "46",
                                  "available": "24"
                              },
      ],
      "virtualServiceLicenses": [
                                {
                                    "name": "Auto Attendant - Basic",
                                    "licensed": "33",
                                    "used": "13",
                                    "available": "20"
                                },
      ],
      "userServiceLicenses": [
                              {
                                  "name": "1BASE",
                                  "licensed": "Unlimited",
                                  "used": "293",
                                  "available": "Unlimited",
                                  "usedByHostedUsers": "107",
                                  "usedByTrunkUsers": "186",
                                  "expirationDate": ""
                              },
      ],
      "systemParamLicenses": [
                              {
                                  "name": "Trunking Call Capacity",
                                  "licensed": "100",
                                  "used": "99",
                                  "available": "1"
                              },
      ],
}
Response JSON Object:

  • licenseStrictness (string) – license type.

  • maxUsersByGroup (integer) – the max number of users in a group that will consume a group license.

  • expirationDate (datetime) – Expiration date. See Datetime utc

  • hostId (array) – a list of host ids. Every host id uniquely identifies a server computer hardware.

  • licenseName (array) – a list of license names. Every license name identifies something that has been licensed.

  • numberOfTrunkUsers (integer) – the number of trunk users.

  • subscriberLicenses (array) – a list of objects as defined in License object attributes.

  • groupServiceLicenses (array) – a list of objects as defined in License object attributes.

  • virtualServiceLicenses (array) – a list of objects as defined in License object attributes.

  • userServiceLicenses (array) – a list of objects as defined in License user service object attributes.

  • systemParamLicenses (array) – a list of objects as defined in License object attributes.

Status Codes: