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

Export an air-gapped request

Make the request file of an air-gapped install: the install ID, the license ID, the console version and the fingerprint of each running database of the license, and of each cluster that a major upgrade or its rollback waits to start. Support answers it with one bundle file. The file holds no secrets and is not signed: it gives no authority.

POST/api/v1/license/request
Authorization
tse_sessionAPI key · cookierequired
Request body
requiredapplication/json
bootstrap_fingerprintsstring[]

The fingerprints of copies that the restore wizard makes and that need a bootstrap grant. Needs license_file

max items 16
license_filestring

The license that the request is for. Absent: a request with only the install ID, before a license is added

max length 128
Responses
200

OK

omittedAirGapOmitted[]required

The services of the license that the console could not read. The request has no fingerprint for them

Show properties
Array of AirGapOmitted
reasonstringrequired
service_idstringrequired
service_namestringrequired
requestAirGapRequestrequired

The request file. Save it as JSON and send it to support

Show properties
console_namestring

The host name of this console. The name of its machine in Keygen

max length 128
console_versionstring
created_atstring<date-time>required
databasesAirGapRequestDatabase[]required

The running databases of the license. Each one gets a license grant

Show properties
Array of AirGapRequestDatabase
fingerprintstringrequired

<system identifier>:<database oid>

namestring

<service>/<database>. The name of its machine in Keygen

max length 128
replacesstring

The fingerprint of the cluster that this database replaces (a major upgrade or its rollback). The hub deletes the machine of that cluster first

formatstringrequired

The version of the file format

Allowed:tsdbe-request-v1
install_idstringrequired

The install ID of this console

license_idstring

The license that the request is for. Absent before a license is added

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/request' \
  -H 'Cookie: tse_session=YOUR_API_KEY' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
  "bootstrap_fingerprints": [
    "string"
  ],
  "license_file": "string"
}'
Response
{
  "omitted": [
    {
      "reason": "string",
      "service_id": "string",
      "service_name": "string"
    }
  ],
  "request": {
    "console_name": "string",
    "console_version": "string",
    "created_at": "2019-08-24T14:15:22Z",
    "databases": [
      {
        "fingerprint": "string",
        "name": "string",
        "replaces": "string"
      }
    ],
    "format": "tsdbe-request-v1",
    "install_id": "string",
    "license_id": "string"
  }
}