Docker Engine API
  1. Container
Docker Engine API
  • System
    • Ping
      GET
    • Check auth configuration
      POST
    • Monitor events
      GET
    • Get system information
      GET
    • Get data usage information
      GET
    • Get version
      GET
  • Image
    • Build an image
    • Delete builder cache
    • Create a new image from a container
    • Create an image
    • Export several images
    • List Images
    • Import images
    • Delete unused images
    • Search images
    • Remove an image
    • Export an image
    • Get the history of an image
    • Inspect an image
    • Push an image
    • Tag an image
  • Config
    • List configs
    • Create a config
    • Delete a config
    • Inspect a config
    • Update a Config
  • Container
    • Create a container
      POST
    • List containers
      GET
    • Delete stopped containers
      POST
    • Remove a container
      DELETE
    • Get an archive of a filesystem resource in a container
      GET
    • Get information about files in a container
      HEAD
    • Extract an archive of files or folders to a directory in a container
      PUT
    • Attach to a container
      POST
    • Attach to a container via a websocket
      GET
    • Get changes on a container’s filesystem
      GET
    • Export a container
      GET
    • Inspect a container
      GET
    • Kill a container
      POST
    • Get container logs
      GET
    • Pause a container
      POST
    • Rename a container
      POST
    • Resize a container TTY
      POST
    • Restart a container
      POST
    • Start a container
      POST
    • Get container stats based on resource usage
      GET
    • Stop a container
      POST
    • List processes running inside a container
      GET
    • Unpause a container
      POST
    • Update a container
      POST
    • Wait for a container
      POST
  • Exec
    • Create an exec instance
    • Inspect an exec instance
    • Resize an exec instance
    • Start an exec instance
  • Distribution
    • Get image information from the registry
  • Network
    • List networks
    • Create a network
    • Delete unused networks
    • Remove a network
    • Inspect a network
    • Connect a container to a network
    • Disconnect a container from a network
  • Node
    • List nodes
    • Delete a node
    • Inspect a node
    • Update a node
  • Plugin
    • List plugins
    • Create a plugin
    • Get plugin privileges
    • Install a plugin
    • Remove a plugin
    • Disable a plugin
    • Enable a plugin
    • Inspect a plugin
    • Push a plugin
    • Configure a plugin
    • Upgrade a plugin
  • Secret
    • List secrets
    • Create a secret
    • Delete a secret
    • Inspect a secret
    • Update a Secret
  • Service
    • List services
    • Create a service
    • Delete a service
    • Inspect a service
    • Get service logs
    • Update a service
  • Session (experimental)
    • Initialize interactive session
  • Swarm
    • Inspect swarm
    • Initialize a new swarm
    • Join an existing swarm
    • Leave a swarm
    • Unlock a locked manager
    • Get the unlock key
    • Update a swarm
  • Task
    • List tasks
    • Inspect a task
  • Volume
    • List volumes
    • Create a volume
    • Delete unused volumes
    • Remove a volume
    • Inspect a volume
  • Get task logs
    GET
  1. Container

Inspect a container

/v1.33
/v1.33
/v1.33
/v1.33
GET
/containers/{id}/json
Container
Return low-level information about a container.
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET '/v1.33/containers//json'
Response Response Example
200 - response
{
    "AppArmorProfile": "",
    "Args": [
        "-c",
        "exit 9"
    ],
    "Config": {
        "AttachStderr": true,
        "AttachStdin": false,
        "AttachStdout": true,
        "Cmd": [
            "/bin/sh",
            "-c",
            "exit 9"
        ],
        "Domainname": "",
        "Env": [
            "PATH=/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin"
        ],
        "Hostname": "ba033ac44011",
        "Image": "ubuntu",
        "Labels": {
            "com.example.license": "GPL",
            "com.example.vendor": "Acme",
            "com.example.version": "1.0"
        },
        "MacAddress": "",
        "NetworkDisabled": false,
        "OpenStdin": false,
        "StdinOnce": false,
        "StopSignal": "SIGTERM",
        "StopTimeout": 10,
        "Tty": false,
        "User": "",
        "Volumes": {
            "/volumes/data": {}
        },
        "WorkingDir": ""
    },
    "Created": "2015-01-06T15:47:31.485331387Z",
    "Driver": "devicemapper",
    "HostConfig": {
        "BlkioDeviceReadBps": [
            {}
        ],
        "BlkioDeviceReadIOps": [
            {}
        ],
        "BlkioDeviceWriteBps": [
            {}
        ],
        "BlkioDeviceWriteIOps": [
            {}
        ],
        "BlkioWeight": 0,
        "BlkioWeightDevice": [
            {}
        ],
        "ContainerIDFile": "",
        "CpuPercent": 80,
        "CpuPeriod": 100000,
        "CpuRealtimePeriod": 1000000,
        "CpuRealtimeRuntime": 10000,
        "CpuShares": 0,
        "CpusetCpus": "",
        "CpusetMems": "",
        "Devices": [],
        "IpcMode": "",
        "KernelMemory": 0,
        "LogConfig": {
            "Type": "json-file"
        },
        "LxcConf": [],
        "MaximumIOBps": 0,
        "MaximumIOps": 0,
        "Memory": 0,
        "MemoryReservation": 0,
        "MemorySwap": 0,
        "NetworkMode": "bridge",
        "OomKillDisable": false,
        "OomScoreAdj": 500,
        "PidMode": "",
        "PortBindings": {},
        "Privileged": false,
        "PublishAllPorts": false,
        "ReadonlyRootfs": false,
        "RestartPolicy": {
            "MaximumRetryCount": 2,
            "Name": "on-failure"
        },
        "ShmSize": 67108864,
        "Sysctls": {
            "net.ipv4.ip_forward": "1"
        },
        "Ulimits": [
            {}
        ],
        "VolumeDriver": ""
    },
    "HostnamePath": "/var/lib/docker/containers/ba033ac4401106a3b513bc9d639eee123ad78ca3616b921167cd74b20e25ed39/hostname",
    "HostsPath": "/var/lib/docker/containers/ba033ac4401106a3b513bc9d639eee123ad78ca3616b921167cd74b20e25ed39/hosts",
    "Id": "ba033ac4401106a3b513bc9d639eee123ad78ca3616b921167cd74b20e25ed39",
    "Image": "04c5d3b7b0656168630d3ba35d8889bd0e9caafcaeb3004d2bfbc47e7c5d35d2",
    "LogPath": "/var/lib/docker/containers/1eb5fabf5a03807136561b3c00adcd2992b535d624d5e18b6cdc6a6844d9767b/1eb5fabf5a03807136561b3c00adcd2992b535d624d5e18b6cdc6a6844d9767b-json.log",
    "MountLabel": "",
    "Mounts": [
        {
            "Destination": "/data",
            "Driver": "local",
            "Mode": "ro,Z",
            "Name": "fac362...80535",
            "Propagation": "",
            "RW": false,
            "Source": "/data"
        }
    ],
    "Name": "/boring_euclid",
    "NetworkSettings": {
        "Bridge": "",
        "EndpointID": "",
        "Gateway": "",
        "GlobalIPv6Address": "",
        "GlobalIPv6PrefixLen": 0,
        "HairpinMode": false,
        "IPAddress": "",
        "IPPrefixLen": 0,
        "IPv6Gateway": "",
        "LinkLocalIPv6Address": "",
        "LinkLocalIPv6PrefixLen": 0,
        "MacAddress": "",
        "Networks": {
            "bridge": {
                "EndpointID": "7587b82f0dada3656fda26588aee72630c6fab1536d36e394b2bfbcf898c971d",
                "Gateway": "172.17.0.1",
                "GlobalIPv6Address": "",
                "GlobalIPv6PrefixLen": 0,
                "IPAddress": "172.17.0.2",
                "IPPrefixLen": 16,
                "IPv6Gateway": "",
                "MacAddress": "02:42:ac:12:00:02",
                "NetworkID": "7ea29fc1412292a2d7bba362f9253545fecdfa8ce9a6e37dd10ba8bee7129812"
            }
        },
        "SandboxID": "",
        "SandboxKey": ""
    },
    "Path": "/bin/sh",
    "ProcessLabel": "",
    "ResolvConfPath": "/var/lib/docker/containers/ba033ac4401106a3b513bc9d639eee123ad78ca3616b921167cd74b20e25ed39/resolv.conf",
    "RestartCount": 1,
    "State": {
        "Dead": false,
        "Error": "",
        "ExitCode": 9,
        "FinishedAt": "2015-01-06T15:47:32.080254511Z",
        "OOMKilled": false,
        "Paused": false,
        "Pid": 0,
        "Restarting": false,
        "Running": true,
        "StartedAt": "2015-01-06T15:47:32.072697474Z",
        "Status": "running"
    }
}

Request

Path Params
id
string 
required
ID or name of the container
Query Params
size
string 
optional
Return the size of container as fields SizeRw and SizeRootFs

Responses

🟢200no error
application/json
Body
AppArmorProfile
string 
optional
Args
array[string]
optional
The arguments to the command being run
Config
object (ContainerConfig) 
optional
Configuration for a container that is portable between hosts
ArgsEscaped
boolean 
optional
Command is already escaped (Windows only)
AttachStderr
boolean 
optional
Whether to attach to stderr.
Default:
true
AttachStdin
boolean 
optional
Whether to attach to stdin.
Default:
false
AttachStdout
boolean 
optional
Whether to attach to stdout.
Default:
true
Cmd
optional
Command to run specified as a string or an array of strings.
Domainname
string 
optional
The domain name to use for the container.
Entrypoint
optional
The entry point for the container as a string or an array of strings.
If the array consists of exactly one empty string ([""]) then the entry point is reset to system default (i.e., the entry point used by docker when there is no ENTRYPOINT instruction in the Dockerfile).
Env
array[string]
optional
A list of environment variables to set inside the container in the form ["VAR=value", ...]. A variable without = is removed from the environment, rather than to have an empty value.
ExposedPorts
object 
optional
An object mapping ports to an empty object in the form:
{"<port>/<tcp|udp>": {}}
Healthcheck
object (HealthConfig) 
optional
A test to perform to check that the container is healthy.
Hostname
string 
optional
The hostname to use for the container, as a valid RFC 1123 hostname.
Image
string 
optional
The name of the image to use when creating the container
Labels
object 
optional
User-defined key/value metadata.
MacAddress
string 
optional
MAC address of the container.
NetworkDisabled
boolean 
optional
Disable networking for the container.
OnBuild
array[string]
optional
ONBUILD metadata that were defined in the image's Dockerfile.
OpenStdin
boolean 
optional
Open stdin
Default:
false
Shell
array[string]
optional
Shell for when RUN, CMD, and ENTRYPOINT uses a shell.
StdinOnce
boolean 
optional
Close stdin after one attached client disconnects
Default:
false
StopSignal
string 
optional
Signal to stop a container as a string or unsigned integer.
Default:
SIGTERM
StopTimeout
integer 
optional
Timeout to stop a container in seconds.
Default:
10
Tty
boolean 
optional
Attach standard streams to a TTY, including stdin if it is not closed.
Default:
false
User
string 
optional
The user that commands are run as inside the container.
Volumes
object 
optional
An object mapping mount point paths inside the container to empty objects.
WorkingDir
string 
optional
The working directory for commands to run in.
Created
string 
optional
The time the container was created
Driver
string 
optional
ExecIDs
string 
optional
GraphDriver
object (GraphDriverData) 
optional
Information about a container's graph driver.
Data
object 
required
Name
string 
required
HostConfig
object (HostConfig) 
optional
Container configuration that depends on the host we are running on
BlkioDeviceReadBps
array[object (ThrottleDevice) {2}] 
optional
Limit read rate (bytes per second) from a device, in the form [{"Path": "device_path", "Rate": rate}].
BlkioDeviceReadIOps
array[object (ThrottleDevice) {2}] 
optional
Limit read rate (IO per second) from a device, in the form [{"Path": "device_path", "Rate": rate}].
BlkioDeviceWriteBps
array[object (ThrottleDevice) {2}] 
optional
Limit write rate (bytes per second) to a device, in the form [{"Path": "device_path", "Rate": rate}].
BlkioDeviceWriteIOps
array[object (ThrottleDevice) {2}] 
optional
Limit write rate (IO per second) to a device, in the form [{"Path": "device_path", "Rate": rate}].
BlkioWeight
integer 
optional
Block IO weight (relative weight).
>= 0<= 1000
BlkioWeightDevice
array [object {2}] 
optional
Block IO weight (relative device weight) in the form [{"Path": "device_path", "Weight": weight}].
CgroupParent
string 
optional
Path to cgroups under which the container's cgroup is created. If the path is not absolute, the path is considered to be relative to the cgroups path of the init process. Cgroups are created if they do not already exist.
CpuCount
integer <int64>
optional
The number of usable CPUs (Windows only).
On Windows Server containers, the processor resource controls are mutually exclusive. The order of precedence is CPUCount first, then CPUShares, and CPUPercent last.
CpuPercent
integer <int64>
optional
The usable percentage of the available CPUs (Windows only).
On Windows Server containers, the processor resource controls are mutually exclusive. The order of precedence is CPUCount first, then CPUShares, and CPUPercent last.
CpuPeriod
integer <int64>
optional
The length of a CPU period in microseconds.
CpuQuota
integer <int64>
optional
Microseconds of CPU time that the container can get in a CPU period.
CpuRealtimePeriod
integer <int64>
optional
The length of a CPU real-time period in microseconds. Set to 0 to allocate no time allocated to real-time tasks.
CpuRealtimeRuntime
integer <int64>
optional
The length of a CPU real-time runtime in microseconds. Set to 0 to allocate no time allocated to real-time tasks.
CpuShares
integer 
optional
An integer value representing this container's relative CPU weight versus other containers.
CpusetCpus
string 
optional
CPUs in which to allow execution (e.g., 0-3, 0,1)
Example:
0-3
CpusetMems
string 
optional
Memory nodes (MEMs) in which to allow execution (0-3, 0,1). Only effective on NUMA systems.
DeviceCgroupRules
array[string]
optional
a list of cgroup rules to apply to the container
Devices
array[object (DeviceMapping) {3}] 
optional
A list of devices to add to the container.
DiskQuota
integer <int64>
optional
Disk limit (in bytes).
IOMaximumBandwidth
integer <int64>
optional
Maximum IO in bytes per second for the container system drive (Windows only)
IOMaximumIOps
integer <int64>
optional
Maximum IOps for the container system drive (Windows only)
KernelMemory
integer <int64>
optional
Kernel memory limit in bytes.
Memory
integer 
optional
Memory limit in bytes.
Default:
0
MemoryReservation
integer <int64>
optional
Memory soft limit in bytes.
MemorySwap
integer <int64>
optional
Total memory limit (memory + swap). Set as -1 to enable unlimited swap.
MemorySwappiness
integer <int64>
optional
Tune a container's memory swappiness behavior. Accepts an integer between 0 and 100.
>= 0<= 100
NanoCPUs
integer <int64>
optional
CPU quota in units of 10-9 CPUs.
OomKillDisable
boolean 
optional
Disable OOM Killer for the container.
PidsLimit
integer <int64>
optional
Tune a container's pids limit. Set -1 for unlimited.
Ulimits
array [object {3}] 
optional
A list of resource limits to set in the container. For example: {"Name": "nofile", "Soft": 1024, "Hard": 2048}"
AutoRemove
boolean 
optional
Automatically remove the container when the container's process exits. This has no effect if RestartPolicy is set.
Binds
array[string]
optional
A list of volume bindings for this container. Each volume binding is a string in one of these forms:
host-src:container-dest to bind-mount a host path into the container. Both host-src, and container-dest must be an absolute path.
host-src:container-dest:ro to make the bind mount read-only inside the container. Both host-src, and container-dest must be an absolute path.
volume-name:container-dest to bind-mount a volume managed by a volume driver into the container. container-dest must be an absolute path.
volume-name:container-dest:ro to mount the volume read-only inside the container. container-dest must be an absolute path.
CapAdd
array[string]
optional
A list of kernel capabilities to add to the container.
CapDrop
array[string]
optional
A list of kernel capabilities to drop from the container.
Cgroup
string 
optional
Cgroup to use for the container.
ConsoleSize
array[integer]
optional
Initial console size, as an [height, width] array. (Windows only)
>= 2 items<= 2 items
ContainerIDFile
string 
optional
Path to a file where the container ID is written
Dns
array[string]
optional
A list of DNS servers for the container to use.
DnsOptions
array[string]
optional
A list of DNS options.
DnsSearch
array[string]
optional
A list of DNS search domains.
ExtraHosts
array[string]
optional
A list of hostnames/IP mappings to add to the container's /etc/hosts file. Specified in the form ["hostname:IP"].
GroupAdd
array[string]
optional
A list of additional groups that the container process will run as.
IpcMode
string 
optional
IPC sharing mode for the container. Possible values are:
"none": own private IPC namespace, with /dev/shm not mounted
"private": own private IPC namespace
"shareable": own private IPC namespace, with a possibility to share it with other containers
"container:<name|id>": join another (shareable) container's IPC namespace
"host": use the host system's IPC namespace
If not specified, daemon default is used, which can either be "private"
or "shareable", depending on daemon version and configuration.
Isolation
enum<string> 
optional
Isolation technology of the container. (Windows only)
Allowed values:
defaultprocesshyperv
Links
array[string]
optional
A list of links for the container in the form container_name:alias.
LogConfig
object 
optional
The logging configuration for this container
Mounts
array[object (Mount) {8}] 
optional
Specification for mounts to be added to the container.
NetworkMode
string 
optional
Network mode to use for this container. Supported standard values are: bridge, host, none, and container:<name|id>. Any other value is taken as a custom network's name to which this container should connect to.
OomScoreAdj
integer 
optional
An integer value containing the score given to the container in order to tune OOM killer preferences.
Example:
500
PidMode
string 
optional
Set the PID (Process) Namespace mode for the container. It can be either:
"container:<name|id>": joins another container's PID namespace
"host": use the host's PID namespace inside the container
PortBindings
object 
optional
A map of exposed container ports and the host port they should map to.
Privileged
boolean 
optional
Gives the container full access to the host.
PublishAllPorts
boolean 
optional
Allocates a random host port for all of a container's exposed ports.
ReadonlyRootfs
boolean 
optional
Mount the container's root filesystem as read only.
RestartPolicy
object 
RestartPolicy
optional
The behavior to apply when the container exits. The default is not to restart.
An ever increasing delay (double the previous delay, starting at 100ms) is added before each restart to prevent flooding the server.
Runtime
string 
optional
Runtime to use with this container.
SecurityOpt
array[string]
optional
A list of string values to customize labels for MLS systems, such as SELinux.
ShmSize
integer 
optional
Size of /dev/shm in bytes. If omitted, the system uses 64MB.
>= 0
StorageOpt
object 
optional
Storage driver options for this container, in the form {"size": "120G"}.
Sysctls
object 
optional
A list of kernel parameters (sysctls) to set in the container. For example: {"net.ipv4.ip_forward": "1"}
Tmpfs
object 
optional
A map of container directories which should be replaced by tmpfs mounts, and their corresponding mount options. For example: { "/run": "rw,noexec,nosuid,size=65536k" }.
UTSMode
string 
optional
UTS namespace to use for the container.
UsernsMode
string 
optional
Sets the usernamespace mode for the container when usernamespace remapping option is enabled.
VolumeDriver
string 
optional
Driver that this container uses to mount volumes.
VolumesFrom
array[string]
optional
A list of volumes to inherit from another container, specified in the form <container name>[:<ro|rw>].
HostnamePath
string 
optional
HostsPath
string 
optional
Id
string 
optional
The ID of the container
Image
string 
optional
The container's image
LogPath
string 
optional
MountLabel
string 
optional
Mounts
array[object (MountPoint) {8}] 
optional
Destination
string 
optional
Driver
string 
optional
Mode
string 
optional
Name
string 
optional
Propagation
string 
optional
RW
boolean 
optional
Source
string 
optional
Type
string 
optional
Name
string 
optional
NetworkSettings
object (NetworkSettings) 
optional
NetworkSettings exposes the network settings in the API
Bridge
string 
optional
Name of the network'a bridge (for example, docker0).
Example:
docker0
EndpointID
string 
optional
EndpointID uniquely represents a service endpoint in a Sandbox.

Deprecated: This field is only propagated when attached to the
default "bridge" network. Use the information from the "bridge"
network inside the Networks map instead, which contains the same
information. This field was deprecated in Docker 1.9 and is scheduled
to be removed in Docker 17.12.0
Example:
b88f5b905aabf2893f3cbc4ee42d1ea7980bbc0a92e2c8922b1e1795298afb0b
Gateway
string 
optional
Gateway address for the default "bridge" network.

Deprecated: This field is only propagated when attached to the
default "bridge" network. Use the information from the "bridge"
network inside the Networks map instead, which contains the same
information. This field was deprecated in Docker 1.9 and is scheduled
to be removed in Docker 17.12.0
Example:
172.17.0.1
GlobalIPv6Address
string 
optional
Global IPv6 address for the default "bridge" network.

Deprecated: This field is only propagated when attached to the
default "bridge" network. Use the information from the "bridge"
network inside the Networks map instead, which contains the same
information. This field was deprecated in Docker 1.9 and is scheduled
to be removed in Docker 17.12.0
Example:
2001:db8::5689
GlobalIPv6PrefixLen
integer 
optional
Mask length of the global IPv6 address.

Deprecated: This field is only propagated when attached to the
default "bridge" network. Use the information from the "bridge"
network inside the Networks map instead, which contains the same
information. This field was deprecated in Docker 1.9 and is scheduled
to be removed in Docker 17.12.0
Example:
64
HairpinMode
boolean 
optional
Indicates if hairpin NAT should be enabled on the virtual interface.
Example:
false
IPAddress
string 
optional
IPv4 address for the default "bridge" network.

Deprecated: This field is only propagated when attached to the
default "bridge" network. Use the information from the "bridge"
network inside the Networks map instead, which contains the same
information. This field was deprecated in Docker 1.9 and is scheduled
to be removed in Docker 17.12.0
Example:
172.17.0.4
IPPrefixLen
integer 
optional
Mask length of the IPv4 address.

Deprecated: This field is only propagated when attached to the
default "bridge" network. Use the information from the "bridge"
network inside the Networks map instead, which contains the same
information. This field was deprecated in Docker 1.9 and is scheduled
to be removed in Docker 17.12.0
Example:
16
IPv6Gateway
string 
optional
IPv6 gateway address for this network.

Deprecated: This field is only propagated when attached to the
default "bridge" network. Use the information from the "bridge"
network inside the Networks map instead, which contains the same
information. This field was deprecated in Docker 1.9 and is scheduled
to be removed in Docker 17.12.0
Example:
2001:db8:2::100
LinkLocalIPv6Address
string 
optional
IPv6 unicast address using the link-local prefix.
Example:
fe80::42:acff:fe11:1
LinkLocalIPv6PrefixLen
integer 
optional
Prefix length of the IPv6 unicast address.
Example:
64
MacAddress
string 
optional
MAC address for the container on the default "bridge" network.

Deprecated: This field is only propagated when attached to the
default "bridge" network. Use the information from the "bridge"
network inside the Networks map instead, which contains the same
information. This field was deprecated in Docker 1.9 and is scheduled
to be removed in Docker 17.12.0
Example:
02:42:ac:11:00:04
Networks
object 
optional
Information about all networks that the container is connected to.
Ports
object (PortMap) 
optional
PortMap describes the mapping of container ports to host ports, using the
container's port-number and protocol as key in the format <port>/<protocol>,
for example, 80/udp.
If a container's port is mapped for both tcp and udp, two separate
entries are added to the mapping table.
Example:
{"2377/tcp":null,"443/tcp":[{"HostIp":"127.0.0.1","HostPort":"4443"}],"53/udp":[{"HostIp":"0.0.0.0","HostPort":"53"}],"80/tcp":[{"HostIp":"0.0.0.0","HostPort":"80"},{"HostIp":"0.0.0.0","HostPort":"8080"}],"80/udp":[{"HostIp":"0.0.0.0","HostPort":"80"}]}
SandboxID
string 
optional
SandboxID uniquely represents a container's network stack.
Example:
9d12daf2c33f5959c8bf90aa513e4f65b561738661003029ec84830cd503a0c3
SandboxKey
string 
optional
SandboxKey identifies the sandbox
Example:
/var/run/docker/netns/8ab54b426c38
SecondaryIPAddresses
array[object (Address) {2}]  | null 
optional
SecondaryIPv6Addresses
array[object (Address) {2}]  | null 
optional
Node
object 
optional
TODO
Path
string 
optional
The path to the command being run
ProcessLabel
string 
optional
ResolvConfPath
string 
optional
RestartCount
integer 
optional
SizeRootFs
integer <int64>
optional
The total size of all the files in this container.
SizeRw
integer <int64>
optional
The size of files that have been created or changed by this container.
State
object 
optional
The state of the container.
Dead
boolean 
optional
Error
string 
optional
ExitCode
integer 
optional
The last exit code of this container
FinishedAt
string 
optional
The time when this container last exited.
OOMKilled
boolean 
optional
Whether this container has been killed because it ran out of memory.
Paused
boolean 
optional
Whether this container is paused.
Pid
integer 
optional
The process ID of this container
Restarting
boolean 
optional
Whether this container is restarting.
Running
boolean 
optional
Whether this container is running.
Note that a running container can be paused. The Running and Paused
booleans are not mutually exclusive:
When pausing a container (on Linux), the cgroups freezer is used to suspend
all processes in the container. Freezing the process requires the process to
be running. As a result, paused containers are both Running and Paused.
Use the Status field instead to determine if a container's state is "running".
StartedAt
string 
optional
The time when this container was last started.
Status
enum<string> 
optional
The status of the container. For example, "running" or "exited".
Allowed values:
createdrunningpausedrestartingremovingexiteddead
🟠404no such container
🔴500server error
Modified at 2022-09-10 17:56:06
Previous
Export a container
Next
Kill a container
Built with