Skip to content
You're viewing documentation for v2026.11.12-beta. It may be out of date.Go to latest
TimescaleDB Enterprise
Esc
↑↓navigate↵open⌘Jpreview

Check which licenses fit

Check which installed licenses fit a proposed service topology.

POST/api/v1/license/fit
Authorization
tse_sessionAPI key · cookierequired
Request body
requiredapplication/json
backup_server_idstring

Backup server of the proposed service. enforcing looks at it too

dcs_cluster_idstring

DCS cluster of the proposed advanced_ha service. enforcing looks at its servers too

server_idsstring[]

PG node server ids for the proposed service (empty to check topology-level fit before servers are chosen)

service_idstring

Existing service being rebound: its own license does not count as in use, and its servers are checked when server_ids is empty

sizestring

Size (a tier name from sizes) that a trial license gets; the restart prediction uses it

topologystring

single_node | standard_ha | advanced_ha

Responses
200

OK

current_sizestring
enforcingbooleanrequired
licensesLicenseFitEntry[]required
Show properties
Array of LicenseFitEntry
entitlementsstring[]required
expirystring<date-time>
filestringrequired
fitsbooleanrequired
idstring
max_machinesinteger<int64>required
max_memory_gbinteger<int64>required
max_vcpusinteger<int64>required
namestring
reasonstring
restartstring
Allowed:requiredsuggested
serviceServiceRef
Show properties
idstringrequired
namestringrequired
server_countinteger<int64>required
statusstringrequired
tierstring
recommended_filestring
recommended_sizestring
serversLicenseFitServer[]required
Show properties
Array of LicenseFitServer
idstringrequired
memory_gbinteger<int64>required
vcpusinteger<int64>required
sizesLicenseSize[]required
Show properties
Array of LicenseSize
max_memory_gbinteger<int64>required
max_vcpusinteger<int64>required
namestringrequired
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 POST 'https://console.example.com/api/v1/license/fit' \
  -H 'Cookie: tse_session=YOUR_API_KEY' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
  "backup_server_id": "string",
  "dcs_cluster_id": "string",
  "server_ids": [
    "string"
  ],
  "service_id": "string",
  "size": "string",
  "topology": "string"
}'
Response
{
  "current_size": "string",
  "enforcing": true,
  "licenses": [
    {
      "entitlements": [
        "string"
      ],
      "expiry": "2019-08-24T14:15:22Z",
      "file": "string",
      "fits": true,
      "id": "string",
      "max_machines": 0,
      "max_memory_gb": 0,
      "max_vcpus": 0,
      "name": "string",
      "reason": "string",
      "restart": "required",
      "service": {
        "id": "string",
        "name": "string",
        "server_count": 0
      },
      "status": "string",
      "tier": "string"
    }
  ],
  "recommended_file": "string",
  "recommended_size": "string",
  "servers": [
    {
      "id": "string",
      "memory_gb": 0,
      "vcpus": 0
    }
  ],
  "sizes": [
    {
      "max_memory_gb": 0,
      "max_vcpus": 0,
      "name": "string"
    }
  ]
}