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

Changes

Changed in 4 of the 36 revisions of this API.126

  • 1852f5ad2daa2See the full diff
    • ○

      added the new optional query request parameter removeVolumes

      new-optional-request-parameter

    • ○

      added the non-success response with the status 400

      response-non-success-status-added

  • d58cf9d6195b2See the full diff
    • ○

      removed the ADMIRAL_REQUIRED enum value from the code response property for the response status 403

      response-property-enum-value-removed

    • ○

      removed the ADMIRAL_REQUIRED enum value from the code response property for the response status 500

      response-property-enum-value-removed

  • 7464894ea58222See the full diff
    • ●

      added the new PAID_REQUIRED enum value to the code response property for the response status 403

      response-property-enum-value-added

    • ●

      added the new PAID_REQUIRED enum value to the code response property for the response status 500

      response-property-enum-value-added

    • ○

      removed the PRO_REQUIRED enum value from the code response property for the response status 403

      response-property-enum-value-removed

    • ○

      removed the PRO_REQUIRED enum value from the code response property for the response status 500

      response-property-enum-value-removed

  • c62bbceae8241See the full diff
    • ▲

      added the pattern ^[a-zA-Z0-9_-]+$ to the path request parameter stackName

      request-parameter-pattern-added