STstudio-saelix
Containers

List all containers

Changed on

Returns all running containers on the target node.

get/api/containers

Request

  • Base URL
    https://localhost:1852
  • URL
    https://localhost:1852/api/containers
  • Auth
    HTTP bearer

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

  • 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

  • 7464894ea582Revision changes
    • warning

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

    • warning

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

    • info

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

    • info

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