Stacks

Tear down stack

Runs docker compose down for the stack, removing containers and networks. Requires stack:deploy permission.

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.

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"
}

Changes