Query parameters

• all boolean

  Return all containers. By default, only running containers are shown.

  Default value is false.

• limit integer

  Return this number of most recently created containers, including non-running ones.

• size boolean

  Return the size of container as fields SizeRw and SizeRootFs.

  Default value is false.

• filters string

  Filters to process on the container list, encoded as JSON (a map[string][]string). For example, {"status": ["paused"]} will only return paused containers.

  Available filters:

  • ancestor=(<image-name>[:<tag>], <image id>, or <image@digest>)
  • before=(<container id> or <container name>)
  • expose=(<port>[/<proto>]|<startport-endport>/[<proto>])
  • exited=<int> containers with exit code of <int>
  • health=(starting|healthy|unhealthy|none)
  • id=<ID> a container's ID
  • isolation=(default|process|hyperv) (Windows daemon only)
  • is-task=(true|false)
  • label=key or label="key=value" of a container label
  • name=<name> a container's name
  • network=(<network id> or <network name>)
  • publish=(<port>[/<proto>]|<startport-endport>/[<proto>])
  • since=(<container id> or <container name>)
  • status=(created|restarting|running|removing|paused|exited|dead)
  • volume=(<volume name> or <mount point destination>)

Responses

• 200 application/json

  no error

  Hide response attributes Show response attributes object

  • Id string

    The ID of this container

  • Names array[string]

    The names that this container has been given

  • Image string

    The name of the image used when creating this container

  • ImageID string

    The ID of the image that this container was created from

  • Command string

    Command to run when starting the container

  • Created integer(int64)

    When the container was created

  • Ports array[object]

    The ports exposed by this container

    An open port on a container

    Hide Ports attributes Show Ports attributes object

    • IP string(ip-address)

      Host IP address that the container's port is mapped to

    • PrivatePort integer(uint16) Required

      Port on the container

    • PublicPort integer(uint16)

      Port exposed on the host

    • Type string Required

      Values are tcp, udp, or sctp.

  • SizeRw integer(int64)

    The size of files that have been created or changed by this container

  • SizeRootFs integer(int64)

    The total size of all the files in this container

  • Labels object

    User-defined key/value metadata.

    Hide Labels attribute Show Labels attribute object

    • * string Additional properties
  • State string

    The state of this container (e.g. Exited)

  • Status string

    Additional human-readable status of this container (e.g. Exit 0)

  • HostConfig object
    Hide HostConfig attribute Show HostConfig attribute object

    • NetworkMode string
  • NetworkSettings object

    A summary of the container's network settings

    Hide NetworkSettings attribute Show NetworkSettings attribute object

    • Networks object
      Hide Networks attribute Show Networks attribute object

      • * object Additional properties

        Configuration for a network endpoint.

        Hide * attributes Show * attributes object

        • IPAMConfig object

          EndpointIPAMConfig represents an endpoint's IPAM configuration.

          Hide IPAMConfig attributes Show IPAMConfig attributes object

          • IPv4Address string
          • IPv6Address string
          • LinkLocalIPs array[string]
        • Links array[string]
        • MacAddress string

          MAC address for the endpoint on this network. The network driver might ignore this parameter.

        • Aliases array[string]
        • NetworkID string

          Unique ID of the network.

        • EndpointID string

          Unique ID for the service endpoint in a Sandbox.

        • Gateway string

          Gateway address for this network.

        • IPAddress string

          IPv4 address.

        • IPPrefixLen integer

          Mask length of the IPv4 address.

        • IPv6Gateway string

          IPv6 gateway address.

        • GlobalIPv6Address string

          Global IPv6 address.

        • GlobalIPv6PrefixLen integer(int64)

          Mask length of the global IPv6 address.

        • DriverOpts object

          DriverOpts is a mapping of driver options and values. These options are passed directly to the driver and are driver specific.

          Hide DriverOpts attribute Show DriverOpts attribute object

          • * string Additional properties
        • DNSNames array[string]

          List of all DNS names an endpoint has on a specific network. This list is based on the container name, network aliases, container short ID, and hostname.

          These DNS names are non-fully qualified but can contain several dots. You can get fully qualified DNS names by appending .<network-name>. For instance, if container name is my.ctr and the network is named testnet, DNSNames will contain my.ctr and the FQDN will be my.ctr.testnet.

  • Mounts array[object]

    MountPoint represents a mount point configuration inside the container. This is used for reporting the mountpoints in use by a container.

    Hide Mounts attributes Show Mounts attributes object

    • Type string

      The mount type:

      • bind a mount of a file or directory from the host into the container.
      • volume a docker volume with the given Name.
      • tmpfs a tmpfs.
      • npipe a named pipe from the host into the container.
      • cluster a Swarm cluster volume

      Values are bind, volume, tmpfs, npipe, or cluster.

    • Name string

      Name is the name reference to the underlying data defined by Source e.g., the volume name.

    • Source string

      Source location of the mount.

      For volumes, this contains the storage location of the volume (within /var/lib/docker/volumes/). For bind-mounts, and npipe, this contains the source (host) part of the bind-mount. For tmpfs mount points, this field is empty.

    • Destination string

      Destination is the path relative to the container root (/) where the Source is mounted inside the container.

    • Driver string

      Driver is the volume driver used to create the volume (if it is a volume).

    • Mode string

      Mode is a comma separated list of options supplied by the user when creating the bind/volume mount.

      The default is platform-specific ("z" on Linux, empty on Windows).

    • RW boolean

      Whether the mount is mounted writable (read-write).

    • Propagation string

      Propagation describes how mounts are propagated from the host into the mount point, and vice-versa. Refer to the Linux kernel documentation for details. This field is not used on Windows.

• 400 application/json

  bad parameter

  Hide response attribute Show response attribute object

  • message string Required

    The error message.

• 500 application/json

  server error

  Hide response attribute Show response attribute object

  • message string Required

    The error message.