Skip to content
TimescaleDB Enterprise
Esc
↑↓navigate↵open⌘Jpreview

Get current license status

Returns the installed licenses, the license consumption, whether the console enforces licenses, and whether a trial is available.

GET/api/v1/license
Authorization
tse_sessionAPI key · cookierequired
Responses
200

OK

enforcingbooleanrequired
install_idstring

The install ID of this console. An air-gapped license is bound to it

license_consumptionLicenseConsumption
Show properties
servicesLicenseConsumptionService[]required
Show properties
Array of LicenseConsumptionService
idstringrequired
license_filestringrequired
license_labelstring
max_memory_gbinteger<int64>required
max_vcpusinteger<int64>required
namestringrequired
notestring
serversinteger<int64>required
tierstringrequired
totalsLicenseConsumptionTotal[]required
Show properties
Array of LicenseConsumptionTotal
countinteger<int64>required
tierstringrequired
licensesLicenseEntry[]required
Show properties
Array of LicenseEntry
detailstring
entitlementsstring[]required
expirystring<date-time>
filestringrequired
grantsServiceGrantState[]

Air-gapped or unbound license only: each database service of the license and the state of its license grant

Show properties
Array of ServiceGrantState
guard_actionstring

With 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

Allowed:deploydeploy_restartrestart
needs_redeployboolean

Licensing is enforced, but the license guard does not run on the cluster. Redeploy the service to install it

reasonstring

not_read and not_needed: why. needs_grant: why, when a major upgrade or its rollback waits for the grant

service_idstringrequired
service_namestringrequired
statestringrequired

granted: 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)

Allowed:grantedneeds_grantnot_readnot_needed
untilstring<date-time>

granted: the grant file ends at this time

idstring
issuedstring<date-time>
max_machinesinteger<int64>required
max_memory_gbinteger<int64>required
max_vcpusinteger<int64>required
namestring
renewableboolean

The console checks this license out online, so the refresh button gets a new term. false: the license was added as a file

serviceServiceRef
Show properties
idstringrequired
namestringrequired
server_countinteger<int64>required
service_countinteger<int64>

The number of database services on this license

statusstringrequired
tierstring
trial_resettableboolean
trial_availablebooleanrequired
default

Error

codestring

Stable code of the refusal, when the route has codes

detailsstring[]

Additional detail, e.g. per-field validation failures

errorstringrequired

Human-readable error message

Request
curl -X GET 'https://console.example.com/api/v1/license' \
  -H 'Cookie: tse_session=YOUR_API_KEY' \
  -H 'Accept: application/json'
Response
{
  "enforcing": true,
  "install_id": "string",
  "license_consumption": {
    "services": [
      {
        "id": "string",
        "license_file": "string",
        "license_label": "string",
        "max_memory_gb": 0,
        "max_vcpus": 0,
        "name": "string",
        "note": "string",
        "servers": 0,
        "tier": "string"
      }
    ],
    "totals": [
      {
        "count": 0,
        "tier": "string"
      }
    ]
  },
  "licenses": [
    {
      "detail": "string",
      "entitlements": [
        "string"
      ],
      "expiry": "2019-08-24T14:15:22Z",
      "file": "string",
      "grants": [
        {
          "guard_action": "deploy",
          "needs_redeploy": true,
          "reason": "string",
          "service_id": "string",
          "service_name": "string",
          "state": "granted",
          "until": "2019-08-24T14:15:22Z"
        }
      ],
      "id": "string",
      "issued": "2019-08-24T14:15:22Z",
      "max_machines": 0,
      "max_memory_gb": 0,
      "max_vcpus": 0,
      "name": "string",
      "renewable": true,
      "service": {
        "id": "string",
        "name": "string",
        "server_count": 0
      },
      "service_count": 0,
      "status": "string",
      "tier": "string",
      "trial_resettable": true
    }
  ],
  "trial_available": true
}