License status

This API command returns the current license state, including the reason when a license cannot be used. Unlike proofreading commands, it keeps responding while the license is invalid, so you can use it to find out why the service stopped serving requests.

Command name: license_status

Request URL (GET):

http(s)://endpoint/virtual_directory/api?cmd=license_status

Response:

Valid license:

{
  "valid": true,
  "remaining_seconds": 12701397,
  "product_version": "6.16.0.0"
}

Invalid license:

{
  "valid": false,
  "message": "License does not match the current product version. Please re-activate the license.",
  "remaining_seconds": 0,
  "product_version": "6.15.0.0"
}

The examples are abridged. The response contains additional fields reserved for internal use.

Response fields:

Field	Type	Description
valid	boolean	Indicates whether the license is valid
message	string	Returned only when valid is false. States why the license cannot be used. See Common license errors
remaining_seconds	number	Time in seconds until the license expires. 0 when the license is permanent or invalid
product_version	string	The product version the license was activated for. If it differs from the running version, re-activate the license. See Upgrade application version

See also:

• Health check for a lightweight liveness probe.

• License verification for reading the license status from logs.