List release packages
The packs of the release of this console at the pack source (docker.io/timescale/enterprise-packs), with their state: loaded, needed by an enrolled server, or available. The console keeps the list for 10 minutes. When the console cannot read the source, error tells why. With servers, a DCS cluster or a service in the query, check tells which server packages a deploy on these servers needs and does not have, with the check of the deploy; the console then reads the source only when a server needs server packages.
/api/v1/packs/availabletse_sessionAPI key · cookierequiredrefreshbooleanRead the pack source again, not the cached list
server_idsstring[]Servers that get PostgreSQL. With service_id, the servers that the operation adds to the service, for example the new server of a replace
backup_server_idstringThe backup server of a planned service. It needs a base pack only
dcs_cluster_idstringThe DCS cluster of a planned service. Its servers need a base pack only
service_idstringA service: its servers, its backup server, the servers of its DCS cluster, and its PostgreSQL versions
stanza_idstringThe source stanza of a recover or a fork, without service_id: the servers of server_ids need the PostgreSQL versions and the extensions of the source, as the restore checks them. pg_version_minor and timescaledb_version are then ignored
pg_versionstringThe PostgreSQL major of a planned service. Without service_id, the servers of server_ids need it
pg_version_minorstringtimescaledb_versionstringdcsbooleanThe servers of server_ids are the members of a new DCS cluster: they hold no PostgreSQL, so they can run other OS versions and architectures (TSE-1102)
OK
checkPackCheckResponseThe check of the servers of the query (TSE-938). Only a query with servers, a DCS cluster or a service has it
Show propertiesHide properties
extensionsPackExtensionsResponserequiredThe 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 propertiesHide properties
majorsPackExtensionsMajor[]requiredFor 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 propertiesHide properties
PackExtensionsMajorextensionsPackOfferedExtension[]requiredIn the order of the extension catalog
Show propertiesHide properties
PackOfferedExtensionavailablebooleanrequiredThe 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
contribbooleanrequiredThe PostgreSQL packages have the extension: it has no version of its own
default_versionstringrequiredThe newest version of versions, which the deploy installs when the service has no stored version. Empty when versions is empty
descriptionstringrequiredminor_boundbooleanrequiredThe version of the extension is timescaledb_version: it has a build for each PostgreSQL minor (timescaledb)
namestringrequiredExtension name in the console catalog
needs_restartbooleanrequiredA running service creates the extension only after a restart: PostgreSQL loads the preload library only at start
preloadstringrequiredThe library that the extension needs in shared_preload_libraries. Empty when it needs none
requiredbooleanrequiredEvery service has the extension. It cannot be removed
sql_namestringrequiredThe name for CREATE EXTENSION
versionsstring[]requiredThe 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
majorstringrequiredmissingPackMissing[]requiredThe server packages that the servers need and that the console does not have, one item for each OS version and architecture
Show propertiesHide properties
PackMissingcommandstringrequiredThe installer command that loads the file
downloadPackDownloadStateThe last download of the pack since the console started
filestringrequiredThe file of the console release with the pack. For RHEL-compatible (el), * is the minor
labelstringrequiredThe OS version and the architecture, for example Debian 13 arm64 or RHEL-compatible 9 amd64 (RHEL, AlmaLinux, Rocky Linux, Oracle Linux, CentOS Stream)
namestringThe pack of the console release at the source. Empty when the console cannot download the pack: see error
serversstring[]requiredThe servers that need the pack
outdatedPackOutdated[]requiredThe 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 propertiesHide properties
PackOutdatedarchstringrequiredamd64arm64commandstringrequiredThe installer command that loads the file
filestringrequiredThe file of the console release with the pack. For RHEL-compatible (el), * is the minor
labelstringrequiredThe OS version and the architecture, for example Debian 13 arm64 or RHEL-compatible 9 amd64 (RHEL, AlmaLinux, Rocky Linux, Oracle Linux, CentOS Stream)
osstringrequireddebianubuntuelos_versionstringrequiredThe OS version of the pack. For Debian and RHEL-compatible (el), the major only
releasestringrequiredThe release of the newest server packages that these servers get
serversstring[]requiredThe servers that get only server packages of older releases
pack_releasestringrequiredFor 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
refusalstringrequiredThe refusal of a deploy on these servers now, the text of the deploy check. Empty when the server packages allow the deploy
updatesPackServiceUpdatesFor 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 propertiesHide properties
itemsPackUpdateItem[]requiredThe items that the Updates tab of the service lists, each from its version to its newest target
Show propertiesHide properties
PackUpdateItemfromstringrequiredThe version of the service. For patroni and pgbouncer, the version of the pinned server packages
namestringrequiredpostgresql, timescaledb, an extension name of the catalog, patroni, pgbouncer, or a console component item (pgbackrest, tsdbe, tailscale and so on)
tostringrequiredreleasestringrequiredThe 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
versionsPackVersionsResponserequiredFor 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 propertiesHide properties
default_majorstringrequiredThe major that an omitted pg_version deploys. Empty when the offer is empty
majorsPackVersionsMajor[]requiredThe PostgreSQL majors that every server can deploy, newest first. Empty while a server has no loaded server packages
Show propertiesHide properties
PackVersionsMajordefault_minorstringrequiredThe minor that an omitted pg_version_minor deploys: the newest exact minor that every server has
default_timescaledbstringrequiredThe TimescaleDB version that an omitted timescaledb_version deploys
majorstringrequiredminorsPackVersionsMinor[]requiredThe exact minors that every server has, newest first
Show propertiesHide properties
PackVersionsMinorminorstringrequiredtimescaledbstring[]requiredThe TimescaleDB versions of this minor, newest first
checked_atstring<date-time>Time of the last read of the pack source
errorstringWhy the console cannot list the packs of its release
packsAvailablePack[]requiredShow propertiesHide properties
AvailablePackarchstringrequiredamd64arm64contents_before_downloadbooleanThe 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
downloadPackDownloadStateThe last download of this pack since the console started
Show propertiesHide properties
bytesinteger<int64>requiredBytes downloaded so far
errorstringstatestringrequiredqueueddownloadingdonefailedtotalinteger<int64>requiredSize of the pack file in bytes, or -1 when unknown
namestringrequiredPack name, without .tar.zst
needed_bystring[]requiredThe enrolled servers that use this OS and architecture
osstringrequireddebianubuntuelos_versionstringrequiredreleasestringrequiredsize_bytesinteger<int64>requiredSize of the pack file, or -1 when the source does not give it
statusstringrequiredloaded: the console has the verified pack. needed: an enrolled server uses this OS and architecture. available: neither
loadedneededavailablereleasestringrequiredThe release of this console. The console downloads the packs of this release only
sourcestringrequiredThe pack source: the registry repository docker.io/timescale/enterprise-packs
token_setbooleanrequiredTSE_PACK_DOWNLOAD_TOKEN is set
Error
codestringStable code of the refusal, when the route has codes
detailsstring[]Additional detail, e.g. per-field validation failures
errorstringrequiredHuman-readable error message