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

Import an air-gapped bundle

Apply a bundle file from support in one step: add the license file, bind this console, and write each license grant into its database, or give it to the major upgrade that waits for it. The console verifies each file. The answer gives the result of each part: applied, skipped (for example for another console, or applied already) or failed with the reason. Importing the same bundle again changes nothing.

POST/api/v1/license/bundle
Authorization
tse_sessionAPI key · cookierequired
Request body
requiredapplication/json
bundlestringrequired

The contents of the bundle file (tsdbe-bundle-v1)

min length 1 · max length 4194304
Responses
200

OK

omittedAirGapOmitted[]required

The services of the license that the console could not read

Show properties
Array of AirGapOmitted
reasonstringrequired
service_idstringrequired
service_namestringrequired
partsBundlePart[]required

The result of each part of the bundle

Show properties
Array of BundlePart
detailstring
fingerprintstring

For a grant: the database fingerprint

partstringrequired
Allowed:licenseconsolegrant
service_idstring
service_namestring
statusstringrequired
Allowed:appliedskippedfailed
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/bundle' \
  -H 'Cookie: tse_session=YOUR_API_KEY' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
  "bundle": "string"
}'
Response
{
  "omitted": [
    {
      "reason": "string",
      "service_id": "string",
      "service_name": "string"
    }
  ],
  "parts": [
    {
      "detail": "string",
      "fingerprint": "string",
      "part": "license",
      "service_id": "string",
      "service_name": "string",
      "status": "applied"
    }
  ]
}