Stacks

Deploy stack

Runs docker compose up -d for the stack. On Pro tier, uses atomic deployment with automatic rollback on failure. Requires stack:deploy permission.

post/api/stacks/{stackName}/deploy

Path parameters

stackNamestring required
Example:my-stack

Stack directory name (URL-encoded if it contains 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

Stack deployed successfully.

messagestring required

Changes