Get current license status
Returns the installed licenses, the license consumption, whether the console enforces licenses, and whether a trial is available.
/api/v1/licensetse_sessionAPI key · cookierequiredOK
enforcingbooleanrequiredinstall_idstringThe install ID of this console. An air-gapped license is bound to it
license_consumptionLicenseConsumptionShow propertiesHide properties
servicesLicenseConsumptionService[]requiredShow propertiesHide properties
LicenseConsumptionServiceidstringrequiredlicense_filestringrequiredlicense_labelstringmax_memory_gbinteger<int64>requiredmax_vcpusinteger<int64>requirednamestringrequirednotestringserversinteger<int64>requiredtierstringrequiredtotalsLicenseConsumptionTotal[]requiredShow propertiesHide properties
LicenseConsumptionTotalcountinteger<int64>requiredtierstringrequiredlicensesLicenseEntry[]requiredShow propertiesHide properties
LicenseEntrydetailstringentitlementsstring[]requiredexpirystring<date-time>filestringrequiredgrantsServiceGrantState[]Air-gapped or unbound license only: each database service of the license and the state of its license grant
Show propertiesHide properties
ServiceGrantStateguard_actionstringWith needs_redeploy: the action that installs or loads the license guard, as the Overview of the service shows it. deploy: a deploy installs and loads it (HA, or a service that is not running). deploy_restart: a Standard service, a deploy and a restart after it. restart: the last deploy of the Standard service installed it, and a restart loads it
deploydeploy_restartrestartneeds_redeploybooleanLicensing is enforced, but the license guard does not run on the cluster. Redeploy the service to install it
reasonstringnot_read and not_needed: why. needs_grant: why, when a major upgrade or its rollback waits for the grant
service_idstringrequiredservice_namestringrequiredstatestringrequiredgranted: the database has a grant until until. needs_grant: export a request. not_read: the console cannot read the database now (reason). not_needed: licensing is not enforced for this service (reason)
grantedneeds_grantnot_readnot_neededuntilstring<date-time>granted: the grant file ends at this time
idstringissuedstring<date-time>max_machinesinteger<int64>requiredmax_memory_gbinteger<int64>requiredmax_vcpusinteger<int64>requirednamestringrenewablebooleanThe console checks this license out online, so the refresh button gets a new term. false: the license was added as a file
serviceServiceRefShow propertiesHide properties
idstringrequirednamestringrequiredserver_countinteger<int64>requiredservice_countinteger<int64>The number of database services on this license
statusstringrequiredtierstringtrial_resettablebooleantrial_availablebooleanrequiredError
codestringStable code of the refusal, when the route has codes
detailsstring[]Additional detail, e.g. per-field validation failures
errorstringrequiredHuman-readable error message