v34

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

Get environment inventory

Returns a per-stack inventory of environment variables: each variable's source, whether Compose interpolates it or injects it into a container, and a status (present, missing, unused, duplicate, or unpersisted), plus likely-secret classification. Names only: a variable value is never read or returned. When the effective model cannot be rendered, renderable is false and the inventory is derived from the authored source alone. Requires stack:read permission.

get/api/stacks/{stackName}/env-inventory

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

The environment inventory.

stackNamestring required
renderableboolean required

False when the effective model could not be rendered; the inventory is then partial.