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

Changes

Changed in 5 of the 36 revisions of this API.116

  • 40ec058393a32See the full diff
    • ○

      added the non-success response with the status 409

      response-non-success-status-added

    • ○

      added the non-success response with the status 503

      response-non-success-status-added

  • 0c52a67054992See the full diff
    • ○

      added the optional property failure to the response with the 500 status

      response-optional-property-added

    • ○

      added the optional property healthGateId to the response with the 200 status

      response-optional-property-added

  • d58cf9d6195b1See the full diff
    • ○

      removed the ADMIRAL_REQUIRED enum value from the code response property for the response status 403

      response-property-enum-value-removed

  • 7464894ea58211See the full diff
    • ●

      added the new PAID_REQUIRED enum value to the code response property for the response status 403

      response-property-enum-value-added

    • ○

      removed the PRO_REQUIRED enum value from the code response property for the response status 403

      response-property-enum-value-removed

  • c62bbceae8241See the full diff
    • ▲

      added the pattern ^[a-zA-Z0-9_-]+$ to the path request parameter stackName

      request-parameter-pattern-added