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

Upload server packages

Loads the server packages of the request body, as ./timescale-enterprise.sh –pack does: a server package file, or a .tar file with server package files (the file of –make-bundle –packs-only). The console streams the body to the data volume, checks the name and the release of each file, checks the sha256 of each file against the SHA256SUMS of a .tar file, and verifies the signature. It refuses a bad name or a newer release (422) before it stores the body; it reads and discards the body of such a refusal, up to 2.5 GB, so that the client gets the refusal. The limit is 8.0 GB for each file (413). The data volume must have the size of the file (two times for a .tar file) and 1 GB more free (507). A pack with the same name is replaced. The response lists the loaded packs, and the pack list after the upload as GET /packs gives it.

POST/api/v1/packs/upload
Authorization
tse_sessionAPI key · cookierequired
Query parameters
file_namestringrequired

The name of the file: timescale-enterprise-<release>-server-packages-<os>-<version>-<arch>.tar.zst, or a .tar file with such files (timescale-enterprise-<release>-server-packages.tar of --make-bundle --packs-only)

Request body
requiredapplication/octet-stream
string<binary>
Responses
200

OK

importedPackUploaded[]required

The packs of the file that the console loaded

Show properties
Array of PackUploaded
namestringrequired

Pack name, without .tar.zst

textstringrequired

The result line, as the pack-import command writes it

outdatedPackOutdated[]required

The outdated servers after the upload, as GET /packs gives them

Show properties
Array of PackOutdated
archstringrequired
Allowed:amd64arm64
commandstringrequired

The installer command that loads the file

filestringrequired

The file of the console release with the pack. For RHEL-compatible (el), * is the minor

labelstringrequired

The OS version and the architecture, for example Debian 13 arm64 or RHEL-compatible 9 amd64 (RHEL, AlmaLinux, Rocky Linux, Oracle Linux, CentOS Stream)

osstringrequired
Allowed:debianubuntuel
os_versionstringrequired

The OS version of the pack. For Debian and RHEL-compatible (el), the major only

releasestringrequired

The release of the newest server packages that these servers get

serversstring[]required

The servers that get only server packages of older releases

packsPackResponse[]required

The packs after the upload

Show properties
Array of PackResponse
archstringrequired
Allowed:amd64arm64
componentsPackComponentResponse[]required

The server components of a components pack, with their versions. Empty for an OS pack

Show properties
Array of PackComponentResponse
namestringrequired
postgresql_majorstring

The PostgreSQL major of tsdbe

versionstringrequired
installed_onPackInstalledOnResponserequired

The servers that installed packages from this pack, and their deployed services. For a components pack, the servers of its architecture that run a component version whose newest loaded source is this pack (TSE-1047, TSE-1094). POST /packs/remove-unused keeps the pack while this list has a server

Show properties
serversstring[]required

The servers that installed packages from the pack: a workflow started the package step on the server while the pack was the newest base pack of the server. The packages stay on the server after the removal of the pack

servicesstring[]required

The deployed services of these servers

kindstringrequired
Allowed:baseextensionscomponents
namestringrequired

Pack name, without .tar.zst

older_releasebooleanrequired

The pack is of a release older than the console (TSE-953). Always false on a dev console

osstringrequired

debian, ubuntu or el. Empty for a components pack

os_versionstringrequired

Empty for a components pack

pinned_bystring[]required

The services that pin this pack: their PostgreSQL servers install from it. Empty for a components pack

postgresqlPackPGResponse[]required
Show properties
Array of PackPGResponse
majorstringrequired
minorstringrequired
timescaledbstring[]required
reasonstring

Why the console rejected the pack

releasestringrequired
remove_loses_serversstring[]

The enrolled servers with nothing deployed that have no server packages after the removal of this pack. The create wizard asks for their server packages again

remove_refusalstring

Why the console refuses to remove the pack now; empty when an admin can remove it

size_bytesinteger<int64>required
verifiedbooleanrequired
releasestringrequired

The release of this console

release_missingPackReleaseMissing[]required

The missing server packages of the console release after the upload, as GET /packs gives them

Show properties
Array of PackReleaseMissing
archstringrequired
Allowed:amd64arm64
commandstringrequired

The installer command that loads the file

filestringrequired

The file of the console release with the pack. For RHEL-compatible (el), * is the minor

kindstringrequired
Allowed:basecomponents
labelstringrequired

The OS version and the architecture, for example Ubuntu 26.04 amd64, or Server components and the architecture

osstringrequired

debian, ubuntu or el. Empty for a components pack

os_versionstringrequired

The OS version of the pack. For Debian and RHEL-compatible (el), the major only. Empty for a components pack

serversstring[]required

The enrolled servers that need the pack

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/packs/upload?file_name=string' \
  -H 'Cookie: tse_session=YOUR_API_KEY' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/octet-stream' \
  -d 'string'
Response
{
  "imported": [
    {
      "name": "string",
      "text": "string"
    }
  ],
  "outdated": [
    {
      "arch": "amd64",
      "command": "string",
      "file": "string",
      "label": "string",
      "os": "debian",
      "os_version": "string",
      "release": "string",
      "servers": [
        "string"
      ]
    }
  ],
  "packs": [
    {
      "arch": "amd64",
      "components": [
        {
          "name": "string",
          "postgresql_major": "string",
          "version": "string"
        }
      ],
      "installed_on": {
        "servers": [
          "string"
        ],
        "services": [
          "string"
        ]
      },
      "kind": "base",
      "name": "string",
      "older_release": true,
      "os": "string",
      "os_version": "string",
      "pinned_by": [
        "string"
      ],
      "postgresql": [
        {
          "major": "string",
          "minor": "string",
          "timescaledb": [
            "string"
          ]
        }
      ],
      "reason": "string",
      "release": "string",
      "remove_loses_servers": [
        "string"
      ],
      "remove_refusal": "string",
      "size_bytes": 0,
      "verified": true
    }
  ],
  "release": "string",
  "release_missing": [
    {
      "arch": "amd64",
      "command": "string",
      "file": "string",
      "kind": "base",
      "label": "string",
      "os": "string",
      "os_version": "string",
      "servers": [
        "string"
      ]
    }
  ]
}