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

Change a service's license

Bind a database service to a different installed license.

POST/api/v1/database-services/{id}/license
Authorization
tse_sessionAPI key · cookierequired
Path parameters
idstringrequired
Request body
requiredapplication/json
license_filestringrequired

Installed license file id to bind this service to

restartboolean

On a deployed service, also restart PostgreSQL to apply the new caps now (HA: one switchover; Standard: a short outage). Without it, only the caps that need no restart apply now.

sizestring

On a trial license, the size (a tier name) to cap PostgreSQL to. Empty on a trial means no caps. A paid license ignores it.

Responses
200

OK

caps_applystringrequired
Allowed:startednot_startednot_needed
detailstring
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/database-services/string/license' \
  -H 'Cookie: tse_session=YOUR_API_KEY' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
  "license_file": "string",
  "restart": true,
  "size": "string"
}'
Response
{
  "caps_apply": "started",
  "detail": "string"
}