Skip to main content

Stack

namestringrequired
template objectrequired
sourcestringrequired

Where the template came from; empty for a stack no template installed.

idstringrequired
revisionstringrequired
installedAtstring<date-time>required
manuallyEditedbooleanrequired

True once the stack's Compose text was saved by hand (updateStack), so the template's form must not silently overwrite it. A template install is not manually edited.

composestring

The stored docker-compose.yml text. Returned by getStack and updateStack only, never by listStacks. The .env is never returned.

Stack
{
  "name": "string",
  "template": {
    "source": "string",
    "id": "string",
    "revision": "string"
  },
  "installedAt": "2024-07-29T15:51:28.071Z",
  "manuallyEdited": true,
  "compose": "string"
}