Skip to main content

List the catalog's templates

GET 
/catalog

Required role: viewer. An account or token with the viewer or admin role can call this operation.

Example request
curl --request GET \
  --header "Authorization: Bearer $HOSERVA_TOKEN" \
  "https://$HOSERVA_HOST:8008/api/v1/catalog"

The templates of the catalog installed on disk, read from its index.json and never waiting on the network, with the catalog's serial and generatedAt, which are the curated catalog's. The curated catalog's entries come first, then those of each user-added source (listCatalogSources) in the order the sources were added; a template id a source earlier in that order already lists is never supplied by a later one, so a user-added entry cannot shadow a curated one. Every entry names the source it came from (hoserva for the curated catalog, a source id for a user-added source) and carries that source's badge as data: sourceKind and signed. An entry of an unsigned source has signed false. Every entry says whether a stack of that template id already exists (installed, from the stacks table). Entries are in that order. Search, filters and paging are the caller's. lastCheckedAt and lastOutcome report the most recent catalog check (refreshCatalog) since the daemon started, and are absent before any check has run. A catalog that is not installed or whose index.json cannot be read is refused with 503 catalog_unavailable, never answered with an empty list. With checkOnOpen on (getCatalogSettings), a call made when the last check is older than 15 minutes, or when none has run since the daemon started, also starts one catalog check in the background, never a second while one is running. The answer is the on-disk copy as it is now; the finished check is announced as a catalog event on /api/v1/events.

Responses​

The catalog.