STstudio-saelix
Stacks

List effective Compose services

Changed on

Returns the fail-closed effective service model for the stack (declared image, build presence, expected replicas, depends_on, healthcheck). Requires stack:read permission.

get/api/stacks/{stackName}/effective-services

Request

  • Base URL
    https://localhost:1852
  • URL
    https://localhost:1852/api/stacks/{stackName}/effective-services
  • 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

Effective model result.

renderableboolean required
codestring
errorstring

Changes