STstudio-saelix
Stacks

Delete stack

Changed on

Permanently deletes the stack directory and all its files. Requires stack:delete permission. With pruneVolumes=true the stack's volumes are removed too, unless the stack declares a recovery repository volume (or its volumes could not be read), in which case the delete is refused with 423 and nothing is stopped or removed.

delete/api/stacks/{stackName}

Request

  • Base URL
    https://localhost:1852
  • URL
    https://localhost:1852/api/stacks/{stackName}
  • Auth
    HTTP bearer

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

pruneVolumesboolean

When true, also removes the stack's compose volumes. Refused with 423 when the stack declares a recovery repository volume.

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

Stack deleted.

messagestring required

Changes

  • 1f7572eb735fRevision changes
    • info

      added the new optional query request parameter pruneVolumes

    • info

      added the non-success response with the status

  • d58cf9d6195bRevision changes
    • info

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

    • info

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