Skip to main content

CreateStackRequest

namestringrequired

1 to 63 lowercase letters, digits, - or _, starting with a letter or digit. It is the stack's directory name and its Compose project name.

composestringrequired

The docker-compose.yml text.

envstring

The .env text. Write-only: it is stored sealed under the machine key and never returned. Absent means an empty .env. It may not define PATH, HOME, XDG_RUNTIME_DIR, DOCKER_HOST, DOCKER_CONTEXT, DOCKER_CONFIG, DOCKER_CERT_PATH or DOCKER_TLS_VERIFY, which Docker takes from the daemon's environment (400 invalid_stack_env).

template object
sourcestringrequired

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

idstringrequired
revisionstringrequired
CreateStackRequest
{
"name": "string",
"compose": "string",
"env": "string",
"template": {
"source": "string",
"id": "string",
"revision": "string"
}
}