Skip to main content

StackTemplateUpdate

statusstringrequired

Possible values: [update_available, up_to_date, not_from_template, source_removed, template_removed]

sourcestring

The source the stack records; absent when it records none.

templateIdstring

The template the stack records; absent when it records none.

installedRevisioninteger

The revision the stack was installed from; absent for not_from_template.

Possible values: >= 1

availableRevisioninteger

The revision the source lists now; present for update_available and up_to_date.

Possible values: >= 1

sourceKindCatalogSourceKind

curated: Hoserva's own catalog. user_added: a source URL the user added.

Possible values: [curated, user_added]

signedboolean

The source's badge, present with availableRevision: true only when the source's installed archive passed a signature check.

manuallyEditedbooleanrequired

The stack's Compose text was saved by hand, so diff is against the edited file and applying the update would overwrite the edit.

diffstring

Present only for update_available: a unified diff from the stack's docker-compose.yml to the newer revision's compose.yaml.

StackTemplateUpdate
{
  "status": "update_available",
  "source": "string",
  "templateId": "string",
  "installedRevision": 0,
  "availableRevision": 0,
  "sourceKind": "curated",
  "signed": true,
  "manuallyEdited": true,
  "diff": "string"
}