Sign in
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").

Changes

Changed in 2 of the 36 revisions of this API.24

  • d58cf9d6195b2See the full diff
    • ○

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

      response-property-enum-value-removed

    • ○

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

      response-property-enum-value-removed

  • 7464894ea58222See the full diff
    • ●

      added the new PAID_REQUIRED enum value to the code response property for the response status 401

      response-property-enum-value-added

    • ●

      added the new PAID_REQUIRED enum value to the code response property for the response status 500

      response-property-enum-value-added

    • ○

      removed the PRO_REQUIRED enum value from the code response property for the response status 401

      response-property-enum-value-removed

    • ○

      removed the PRO_REQUIRED enum value from the code response property for the response status 500

      response-property-enum-value-removed