v34

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

Check update readiness

Computes an advisory readiness verdict for updating the stack right now, from the stored preflight result, open drift findings, live container health, the pending image change, the rollback backup slot, and node disk headroom. Advisory only: no verdict blocks an update. Requires stack:read permission. Pass service to scope the verdict to one Compose service on a multi-service stack.

get/api/stacks/{stackName}/update-readiness

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

servicestring

When set, readiness is scoped to this Compose service (multi-service stacks only). Stack-wide guardrails still apply; sibling and dependency signals become advisory. Single-service stacks reject this parameter with 400.

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

Readiness report.

stackstring required
computedAtinteger required

Unix timestamp (ms) the report was computed.

verdict'ready' | 'ready_with_warnings' | 'review_required' | 'blocked' | 'unknown' required