v34

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

Stacks

Pull and recreate stack

Pulls latest images and recreates containers (docker compose pull && up -d) using atomic update with automatic rollback on failure. Requires stack:deploy permission.

post/api/stacks/{stackName}/update

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

Update completed.

statusstring required

healthGateIdstring nullable

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

recheckWarningstring

Present when Compose succeeded but post-update image verification still reports an available update or could not fully verify clearance. Optional for older nodes.

Example response

{
  "status": "Update completed"
}