STstudio-saelix
Stacks

Deploy stack

Changed on

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

Request

  • Base URL
    https://localhost:1852
  • URL
    https://localhost:1852/api/stacks/{stackName}/deploy
  • Auth
    HTTP bearer

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"
}

Changes

  • 40ec058393a3Revision changes
    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

  • 0c52a6705499Revision changes
    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status