v34

latestOpenAPI 3.1.0AGPL-3.0-onlyraw.githubusercontent.com2026-08-018932140.9 KB
Stacks

Tear down stack

Runs docker compose down for the stack, removing containers and networks. The stack definition remains on disk. Requires stack:deploy permission. Pass removeVolumes=true to also remove compose volumes when the node advertises the stack-down-remove-volumes capability.

post/api/stacks/{stackName}/down

Path parameters

stackNamestring required
Example:my-stack

Stack directory name. Must match ^[a-zA-Z0-9_-]+$ (alphanumeric characters, hyphens, and underscores only). Returns 400 Invalid stack name if the name contains path separators, dots, spaces, or other special characters.

Query parameters

removeVolumesboolean

When true, runs docker compose down --volumes. Only honored when the target node advertises stack-down-remove-volumes.

Headers

x-node-idinteger
Example:1

Target a specific node by ID. If omitted, the default node is used. Can also be passed as ?nodeId= query parameter.

Response

Command started.

statusstring required

Example response

{
  "status": "Command started"
}