v34

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

Stacks

Get Docker label inventory for a stack

Returns declared Compose labels and runtime container labels per service, with reconciliation hints (only in Compose, only on running container, present in both, or value changed when the values differ) and provenance for each runtime label (compose, image, runtime, compose-system, or unknown when a container or image cannot be inspected). Secret-like label values are redacted unless the caller is an admin and passes reveal=1. Requires stack:read permission.

get/api/stacks/{stackName}/label-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.

Query parameters

reveal'1' | 'true'

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 label inventory.

stackNamestring required

renderableboolean required

False when the Compose model could not be rendered; declared provenance is then unknown.

partialboolean required

A replica or its image could not be fully inspected.

generatedAtinteger required