STstudio-saelix
Stacks

Get stack compose file

Changed on

Returns the compose file Sencho resolved for the stack. That file is compose.yaml, compose.yml, docker-compose.yaml, or docker-compose.yml, and the X-Compose-File response header names it. A compose file that is a symlink to a path outside the stack directory (including another stack's directory), a stack directory that is itself a symlink, or a dangling symlink, is refused.

get/api/stacks/{stackName}

Request

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

Raw compose file content. The X-Compose-File header is the basename that was read.

Changes

  • f59ef834fda6Revision changes
    • info

      added the non-success response with the status

  • d58cf9d6195bRevision changes
    • info

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

    • info

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