Skip to main content

Check whether a stack's template has a newer revision

GET 
/stacks/:name/template-update

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/stacks/{name}/template-update"

Compares the template revision the stack was installed from (its stacks row) with the revision the stack's own source lists now, and never changes the stack, its files or its row: a catalog update is only ever offered, and applying it is the user's action. update_available carries diff, a unified diff from the stack's stored docker-compose.yml to the newer revision's compose.yaml, and the source's badge (sourceKind, signed). A stack that was edited by hand is marked with manuallyEdited and its diff is against the edited file, never as if it were the pristine install. The other statuses carry no diff: up_to_date (the source lists the installed revision or an older one), not_from_template (the stack records no template or no revision number), source_removed (the source the stack was installed from is no longer one of the sources) and template_removed (the source no longer lists the template). A catalog that cannot be read is an error (503 catalog_unavailable), never up_to_date. A GPU device a template install added to the stack's Compose file shows in the diff as removed lines. An unknown stack is 404 stack_not_found; a name that is not a valid stack name is 400 invalid_stack_name.

Request​

Responses​

The comparison.