Sign in

v34

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

List all containers

Returns all running containers on the target node.

get/api/containers

Query parameters

nodeIdinteger
Example:1

Target a specific node by ID (alternative to x-node-id header).

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

Array of container objects.

Idstring

Docker container ID.

Namesstring[]

Container names (prefixed with /).

Servicestring

Compose service name (if part of a stack).

State'running' | 'exited' | 'paused' | 'restarting' | 'dead' | 'created'

Container state.

Statusstring

Human-readable status string (e.g., "Up 2 hours").