v34

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

Restore one Compose service from a recovery snapshot

Retags the captured majority image onto the declared tag and recreates only that service. Body must include recoveryId from a prior service update. Requires stack:deploy.

post/api/stacks/{stackName}/services/{serviceName}/restore

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.

serviceNamestring required

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.

Request body

recoveryIdstring required

Response

Service restore completed.

serviceNamestring required
healthGateIdstring nullable required
observingboolean required
recoveryIdstring nullable
recoveryAvailableboolean required