Skip to content
TimescaleDB Enterprise
Esc
↑↓navigate↵open⌘Jpreview

Download server packages

Downloads each named pack of the release of this console from the pack source, checks its sha256 against SHA256SUMS of the release, verifies its signature and loads it. The downloads run one at a time in the background; GET /packs/available shows their state. The console refuses a pack of another release.

POST/api/v1/packs/download
Authorization
tse_sessionAPI key · cookierequired
Request body
requiredapplication/json
namesstring[]required

Pack names of the console release, or the file names of the packs

min items 1 · max items 32
Responses
202

Accepted

checkPackCheckResponse

The check of the servers of the query (TSE-938). Only a query with servers, a DCS cluster or a service has it

Show properties
extensionsPackExtensionsResponserequired

The extensions that a service can ask for on the PostgreSQL servers: for server_ids, each major of versions; for service_id, the major of the service. Empty while a server has no loaded server packages

Show properties
majorsPackExtensionsMajor[]required

For each PostgreSQL major of the offer, the extensions that a service can ask for on these servers. Empty while a server has no loaded server packages

Show properties
Array of PackExtensionsMajor
extensionsPackOfferedExtension[]required

In the order of the extension catalog

Show properties
Array of PackOfferedExtension
availablebooleanrequired

The server packages of every server have the extension: a contrib extension, a minor_bound extension when the major has a TimescaleDB version, else when versions is not empty

contribbooleanrequired

The PostgreSQL packages have the extension: it has no version of its own

default_versionstringrequired

The newest version of versions, which the deploy installs when the service has no stored version. Empty when versions is empty

descriptionstringrequired
minor_boundbooleanrequired

The version of the extension is timescaledb_version: it has a build for each PostgreSQL minor (timescaledb)

namestringrequired

Extension name in the console catalog

needs_restartbooleanrequired

A running service creates the extension only after a restart: PostgreSQL loads the preload library only at start

preloadstringrequired

The library that the extension needs in shared_preload_libraries. Empty when it needs none

requiredbooleanrequired

Every service has the extension. It cannot be removed

sql_namestringrequired

The name for CREATE EXTENSION

versionsstring[]required

The package versions that the server packages of every server have, newest first. Empty for a contrib extension and for timescaledb, whose version is timescaledb_version

majorstringrequired
missingPackMissing[]required

The server packages that the servers need and that the console does not have, one item for each OS version and architecture

Show properties
Array of PackMissing
commandstringrequired

The installer command that loads the file

downloadPackDownloadState

The last download of the pack since the console started

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)

namestring

The pack of the console release at the source. Empty when the console cannot download the pack: see error

serversstring[]required

The servers that need the pack

outdatedPackOutdated[]required

The servers that get only server packages of releases older than the console, one item for each OS version, architecture and release. A warning only: the deploy continues, but the servers miss the fixes of the console release

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

pack_releasestringrequired

For server_ids without service_id: the release of the server packages that a new service on these servers pins, and whose versions versions has. For service_id: the pin of the service. Empty when there is none

refusalstringrequired

The refusal of a deploy on these servers now, the text of the deploy check. Empty when the server packages allow the deploy

updatesPackServiceUpdates

For service_id: the updates of a running service, the items that its Updates tab lists (updates_available of the service is true). Absent when there is none. It replaces outdated for the servers of a pinned service

Show properties
itemsPackUpdateItem[]required

The items that the Updates tab of the service lists, each from its version to its newest target

Show properties
Array of PackUpdateItem
fromstringrequired

The version of the service. For patroni and pgbouncer, the version of the pinned server packages

namestringrequired

postgresql, timescaledb, an extension name of the catalog, patroni, pgbouncer, or a console component item (pgbackrest, tsdbe, tailscale and so on)

tostringrequired
releasestringrequired

The newest release of the targets of the items: a newer loaded release, or the pin of the service when every target is in its pinned server packages

versionsPackVersionsResponserequired

For server_ids without service_id: the PostgreSQL and TimescaleDB versions that the server packages of every server have. Empty while a server has no loaded server packages

Show properties
default_majorstringrequired

The major that an omitted pg_version deploys. Empty when the offer is empty

majorsPackVersionsMajor[]required

The PostgreSQL majors that every server can deploy, newest first. Empty while a server has no loaded server packages

Show properties
Array of PackVersionsMajor
default_minorstringrequired

The minor that an omitted pg_version_minor deploys: the newest exact minor that every server has

default_timescaledbstringrequired

The TimescaleDB version that an omitted timescaledb_version deploys

majorstringrequired
minorsPackVersionsMinor[]required

The exact minors that every server has, newest first

Show properties
Array of PackVersionsMinor
minorstringrequired
timescaledbstring[]required

The TimescaleDB versions of this minor, newest first

checked_atstring<date-time>

Time of the last read of the pack source

errorstring

Why the console cannot list the packs of its release

packsAvailablePack[]required
Show properties
Array of AvailablePack
archstringrequired
Allowed:amd64arm64
contents_before_downloadboolean

The release has the signed manifest of this pack alone: GET /packs/available/{name}/summary shows the contents before the download. Absent for an older release: the contents show after the download

downloadPackDownloadState

The last download of this pack since the console started

Show properties
bytesinteger<int64>required

Bytes downloaded so far

errorstring
statestringrequired
Allowed:queueddownloadingdonefailed
totalinteger<int64>required

Size of the pack file in bytes, or -1 when unknown

namestringrequired

Pack name, without .tar.zst

needed_bystring[]required

The enrolled servers that use this OS and architecture

osstringrequired
Allowed:debianubuntuel
os_versionstringrequired
releasestringrequired
size_bytesinteger<int64>required

Size of the pack file, or -1 when the source does not give it

statusstringrequired

loaded: the console has the verified pack. needed: an enrolled server uses this OS and architecture. available: neither

Allowed:loadedneededavailable
releasestringrequired

The release of this console. The console downloads the packs of this release only

sourcestringrequired

The pack source: the registry repository docker.io/timescale/enterprise-packs

token_setbooleanrequired

TSE_PACK_DOWNLOAD_TOKEN is set

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/download' \
  -H 'Cookie: tse_session=YOUR_API_KEY' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
  "names": [
    "string"
  ]
}'
Response
{
  "check": {
    "extensions": {
      "majors": [
        {
          "extensions": [
            {
              "available": true,
              "contrib": true,
              "default_version": "string",
              "description": "string",
              "minor_bound": true,
              "name": "string",
              "needs_restart": true,
              "preload": "string",
              "required": true,
              "sql_name": "string",
              "versions": [
                "string"
              ]
            }
          ],
          "major": "string"
        }
      ]
    },
    "missing": [
      {
        "command": "string",
        "download": {
          "bytes": 0,
          "error": "string",
          "state": "queued",
          "total": 0
        },
        "file": "string",
        "label": "string",
        "name": "string",
        "servers": [
          "string"
        ]
      }
    ],
    "outdated": [
      {
        "arch": "amd64",
        "command": "string",
        "file": "string",
        "label": "string",
        "os": "debian",
        "os_version": "string",
        "release": "string",
        "servers": [
          "string"
        ]
      }
    ],
    "pack_release": "string",
    "refusal": "string",
    "updates": {
      "items": [
        {
          "from": "string",
          "name": "string",
          "to": "string"
        }
      ],
      "release": "string"
    },
    "versions": {
      "default_major": "string",
      "majors": [
        {
          "default_minor": "string",
          "default_timescaledb": "string",
          "major": "string",
          "minors": [
            {
              "minor": "string",
              "timescaledb": [
                "string"
              ]
            }
          ]
        }
      ]
    }
  },
  "checked_at": "2019-08-24T14:15:22Z",
  "error": "string",
  "packs": [
    {
      "arch": "amd64",
      "contents_before_download": true,
      "download": {
        "bytes": 0,
        "error": "string",
        "state": "queued",
        "total": 0
      },
      "name": "string",
      "needed_by": [
        "string"
      ],
      "os": "debian",
      "os_version": "string",
      "release": "string",
      "size_bytes": 0,
      "status": "loaded"
    }
  ],
  "release": "string",
  "source": "string",
  "token_set": true
}