StackConfig

stack objectrequired

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.

inputs object[]required

The template's inputs, sorted by name.

Array [

namestringrequired

kindstringrequired

Possible values: [path, port, string, secret, timezone, device]

rolestring

Possible values: [appdata, share, media, downloads, gpu]

labelstring

descriptionstring

valuestring

The value the stack's .env gives the input; empty when it gives none. Absent for a secret.

setboolean

Present on a secret input only: whether the stack's .env gives it a value. The value itself is never returned.

readOnlybooleanrequired

True for a device input, which updateStackConfig refuses to change.

suggestionsstring[]

The existing shares' paths for a path input that is not appdata.

]

StackConfig

{
  "stack": {
    "name": "string",
    "template": {
      "source": "string",
      "id": "string",
      "revision": "string"
    },
    "installedAt": "2024-07-29T15:51:28.071Z",
    "manuallyEdited": true,
    "compose": "string"
  },
  "inputs": [
    {
      "name": "string",
      "kind": "path",
      "role": "appdata",
      "label": "string",
      "description": "string",
      "value": "string",
      "set": true,
      "readOnly": true,
      "suggestions": [
        "string"
      ]
    }
  ]
}