v34

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

Stacks

Deploy stack

Runs docker compose up -d for the stack using 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. 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

Stack deployed successfully.

messagestring required

healthGateIdstring nullable

Id of the post-deploy health gate observation started for this deploy, for use with the health-gate endpoint. Null when the health gate is disabled on the node.

Example response

{
  "message": "Deployed successfully"
}