Get information about the currently installed License

GET

/system/license

curl --request GET \
  --url https://example.com/api/v1/system/license \
  --cookie grommunioAuthJwt=<grommunioAuthJwt>

• Default deployment path

Authorizations

• JWTCookie

Responses

200

License information returned

Media typeapplication/json

object

product

Product name

string

nullable

maxUsers

License user limit

integer

notBefore

Date string with time

string

nullable /^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$/

notAfter

Date string with time

string

nullable /^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$/

currentUsers

Number of currently existing users

integer

nullable

certificate

Download link for the certificate

string

nullable

Example^generated

{
  "product": "example",
  "maxUsers": 1,
  "notBefore": "example",
  "notAfter": "example",
  "currentUsers": 1,
  "certificate": "example"
}

400

Validation of input parameters failed

Media typeapplication/json

object

message

string

errors

List of errors encountered during validation

Array<string>

Example^generated

{
  "message": "example",
  "errors": [
    "example"
  ]
}

500

An error occurred while processing the request

Media typeapplication/json

object

message

String representation of the exception

string

Example^generated

{
  "message": "example"
}

503

The database query failed

Media typeapplication/json

object

message

Description of the error

string

Example^generated

{
  "message": "example"
}