Get system information

Architecture

string

optional

Hardware architecture of the host, as returned by the Go runtime
(GOARCH).

A full list of possible values can be found in the Go documentation.

Example:

x86_64

BridgeNfIp6tables

boolean

optional

Indicates if bridge-nf-call-ip6tables is available on the host.

Example:

true

BridgeNfIptables

boolean

optional

Indicates if bridge-nf-call-iptables is available on the host.

Example:

true

CPUSet

boolean

optional

Indicates if CPUsets (cpuset.cpus, cpuset.mems) are supported by the host.

See cpuset(7)

Example:

true

CPUShares

boolean

optional

Indicates if CPU Shares limiting is supported by the host.

Example:

true

CgroupDriver

enum<string>

optional

The driver to use for managing cgroups.

Allowed values:

cgroupfssystemd

Default:

cgroupfs

Example:

cgroupfs

ClusterAdvertise

string

optional

The network endpoint that the Engine advertises for the purpose of
node discovery. ClusterAdvertise is a host:port combination on which
the daemon is reachable by other hosts.

Note: This field is only propagated when using standalone Swarm
mode, and overlay networking using an external k/v store. Overlay
networks with Swarm mode enabled use the built-in raft store, and
this field will be empty.

Example:

node5.corp.example.com:8000

ClusterStore

string

optional

URL of the distributed storage backend.

The storage backend is used for multihost networking (to store
network and endpoint information) and by the node discovery mechanism.

Note: This field is only propagated when using standalone Swarm
mode, and overlay networking using an external k/v store. Overlay
networks with Swarm mode enabled use the built-in raft store, and
this field will be empty.

Example:

consul://consul.corp.example.com:8600/some/path

ContainerdCommit

object (Commit)

optional

Commit holds the Git-commit (SHA1) that a binary was built from, as
reported in the version-string of external tools, such as containerd,
or runC.

Expected

string

optional

Commit ID of external tool expected by dockerd as set at build time.

Example:

2d41c047c83e09a6d61d464906feb2a2f3c52aa4

string

optional

Actual commit ID of external tool.

Example:

cfb82a876ecc11b5ca0977d1733adbe58599088a

Containers

integer

optional

Total number of containers on the host.

Example:

ContainersPaused

integer

optional

Number of containers with status "paused".

Example:

ContainersRunning

integer

optional

Number of containers with status "running".

Example:

ContainersStopped

integer

optional

Number of containers with status "stopped".

Example:

CpuCfsPeriod

boolean

optional

Indicates if CPU CFS(Completely Fair Scheduler) period is supported by the host.

Example:

true

CpuCfsQuota

boolean

optional

Indicates if CPU CFS(Completely Fair Scheduler) quota is supported by the host.

Example:

true

Debug

boolean

optional

Indicates if the daemon is running in debug-mode / with debug-level logging enabled.

Example:

true

DefaultRuntime

string

optional

Name of the default OCI runtime that is used when starting containers.

The default can be overridden per-container at create time.

Default:

runc

Example:

runc

DockerRootDir

string

optional

Root directory of persistent Docker state.

Defaults to /var/lib/docker on Linux, and C:\ProgramData\docker
on Windows.

Example:

/var/lib/docker

Driver

string

optional

Name of the storage driver in use.

Example:

overlay2

DriverStatus

array [array]

optional

Information specific to the storage driver, provided as
"label" / "value" pairs.

This information is provided by the storage driver, and formatted
in a way consistent with the output of docker info on the command
line.

Note: The information returned in this field, including the
formatting of values and labels, should not be considered stable,
and may change without notice.

Example:

[["Backing Filesystem","extfs"],["Supports d_type","true"],["Native Overlay Diff","true"]]

string

optional

ExperimentalBuild

boolean

optional

Indicates if experimental features are enabled on the daemon.

Example:

true

GenericResources

array [object {2}]

optional

User-defined resources can be either Integer resources (e.g, SSD=3) or String resources (e.g, GPU=UUID1)

Example:

[{"DiscreteResourceSpec":{"Kind":"SSD","Value":3}},{"NamedResourceSpec":{"Kind":"GPU","Value":"UUID1"}},{"NamedResourceSpec":{"Kind":"GPU","Value":"UUID2"}}]

DiscreteResourceSpec

object

optional

NamedResourceSpec

object

optional

HttpProxy

string

optional

HTTP-proxy configured for the daemon. This value is obtained from the
HTTP_PROXY environment variable.

Containers do not automatically inherit this configuration.

Example:

http://user:pass@proxy.corp.example.com:8080

HttpsProxy

string

optional

HTTPS-proxy configured for the daemon. This value is obtained from the
HTTPS_PROXY environment variable.

Containers do not automatically inherit this configuration.

Example:

https://user:pass@proxy.corp.example.com:4443

string

optional

Unique identifier of the daemon.

Note: The format of the ID itself is not part of the API, and
should not be considered stable.

Example:

7TRN:IPZB:QYBB:VPBQ:UMPP:KARE:6ZNR:XE6T:7EWV:PKF4:ZOJD:TPYS

IPv4Forwarding

boolean

optional

Indicates IPv4 forwarding is enabled.

Example:

true

Images

integer

optional

Total number of images on the host.

Both tagged and untagged (dangling) images are counted.

Example:

508

IndexServerAddress

string

optional

Address / URL of the index server that is used for image search,
and as a default for user authentication for Docker Hub and Docker Cloud.

Default:

https://index.docker.io/v1/

Example:

https://index.docker.io/v1/

InitBinary

string

optional

Name and, optional, path of the the docker-init binary.

If the path is omitted, the daemon searches the host's $PATH for the
binary and uses the first result.

Example:

docker-init

InitCommit

object (Commit)

optional

Commit holds the Git-commit (SHA1) that a binary was built from, as
reported in the version-string of external tools, such as containerd,
or runC.

Isolation

enum<string>

optional

Represents the isolation technology to use as a default for containers.
The supported values are platform-specific.

If no isolation value is specified on daemon start, on Windows client,
the default is hyperv, and on Windows server, the default is process.

This option is currently not used on other platforms.

Allowed values:

defaulthypervprocess

Default:

default

KernelMemory

boolean

optional

Indicates if the host has kernel memory limit support enabled.

Example:

true

KernelVersion

string

optional

Kernel version of the host.

On Linux, this information obtained from uname. On Windows this
information is queried from the HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Windows NT\CurrentVersion\
registry value, for example "10.0 14393 (14393.1198.amd64fre.rs1_release_sec.170427-1353)".

Example:

4.9.38-moby

Labels

array[string]

optional

User-defined labels (key/value metadata) as set on the daemon.

Note: When part of a Swarm, nodes can both have daemon labels,
set through the daemon configuration, and node labels, set from a
manager node in the Swarm. Node labels are not included in this
field. Node labels can be retrieved using the /nodes/(id) endpoint
on a manager node in the Swarm.

Example:

["storage=ssd","production"]

LiveRestoreEnabled

boolean

optional

Indicates if live restore is enabled.

If enabled, containers are kept running when the daemon is shutdown
or upon daemon start if running containers are detected.

Default:

false

Example:

false

LoggingDriver

string

optional

The logging driver to use as a default for new containers.

MemTotal

integer <int64>

optional

Total amount of physical memory available on the host, in kilobytes (kB).

Example:

2095882240

MemoryLimit

boolean

optional

Indicates if the host has memory limit support enabled.

Example:

true

NCPU

integer

optional

The number of logical CPUs usable by the daemon.

The number of available CPUs is checked by querying the operating
system when the daemon starts. Changes to operating system CPU
allocation after the daemon is started are not reflected.

Example:

NEventsListener

integer

optional

Number of event listeners subscribed.

Example:

NFd

integer

optional

The total number of file Descriptors in use by the daemon process.

This information is only returned if debug-mode is enabled.

Example:

NGoroutines

integer

optional

The number of goroutines that currently exist.

This information is only returned if debug-mode is enabled.

Example:

174

Name

string

optional

Hostname of the host.

Example:

node5.corp.example.com

NoProxy

string

optional

Comma-separated list of domain extensions for which no proxy should be
used. This value is obtained from the NO_PROXY
environment variable.

Containers do not automatically inherit this configuration.

Example:

*.local, 169.254/16

OSType

string

optional

Generic type of the operating system of the host, as returned by the
Go runtime (GOOS).

Currently returned values are "linux" and "windows". A full list of
possible values can be found in the Go documentation.

Example:

linux

OomKillDisable

boolean

optional

Indicates if OOM killer disable is supported on the host.

OperatingSystem

string

optional

Name of the host's operating system, for example: "Ubuntu 16.04.2 LTS"
or "Windows Server 2016 Datacenter"

Example:

Alpine Linux v3.5

Plugins

object (PluginsInfo)

optional

Available plugins per type.

Note: Only unmanaged (V1) plugins are included in this list.
V1 plugins are "lazily" loaded, and are not returned in this list
if there is no resource using the plugin.

Authorization

array[string]

optional

Names of available authorization plugins.

Example:

["img-authz-plugin","hbm"]

Log

array[string]

optional

Names of available logging-drivers, and logging-driver plugins.

Example:

["awslogs","fluentd","gcplogs","gelf","journald","json-file","logentries","splunk","syslog"]

Network

array[string]

optional

Names of available network-drivers, and network-driver plugins.

Example:

["bridge","host","ipvlan","macvlan","null","overlay"]

Volume

array[string]

optional

Names of available volume-drivers, and network-driver plugins.

Example:

["local"]

RegistryConfig

object (RegistryServiceConfig) | null

optional

RegistryServiceConfig stores daemon registry services configuration.

AllowNondistributableArtifactsCIDRs

array[string]

optional

List of IP ranges to which nondistributable artifacts can be pushed,
using the CIDR syntax RFC 4632.

Some images (for example, Windows base images) contain artifacts
whose distribution is restricted by license. When these images are
pushed to a registry, restricted artifacts are not included.

This configuration override this behavior, and enables the daemon to
push nondistributable artifacts to all registries whose resolved IP
address is within the subnet described by the CIDR syntax.

This option is useful when pushing images containing
nondistributable artifacts to a registry on an air-gapped network so
hosts on that network can pull the images without connecting to
another server.

Warning: Nondistributable artifacts typically have restrictions
on how and where they can be distributed and shared. Only use this
feature to push artifacts to private registries and ensure that you
are in compliance with any terms that cover redistributing
nondistributable artifacts.

Example:

["::1/128","127.0.0.0/8"]

AllowNondistributableArtifactsHostnames

array[string]

optional

List of registry hostnames to which nondistributable artifacts can be
pushed, using the format <hostname>[:<port>] or <IP address>[:<port>].

Some images (for example, Windows base images) contain artifacts
whose distribution is restricted by license. When these images are
pushed to a registry, restricted artifacts are not included.

This configuration override this behavior for the specified
registries.

Warning: Nondistributable artifacts typically have restrictions
on how and where they can be distributed and shared. Only use this
feature to push artifacts to private registries and ensure that you
are in compliance with any terms that cover redistributing
nondistributable artifacts.

Example:

["registry.internal.corp.example.com:3000","[2001:db8:a0b:12f0::1]:443"]

IndexConfigs

object

optional

Example:

{"127.0.0.1:5000":{"Mirrors":[],"Name":"127.0.0.1:5000","Official":false,"Secure":false},"[2001:db8:a0b:12f0::1]:80":{"Mirrors":[],"Name":"[2001:db8:a0b:12f0::1]:80","Official":false,"Secure":false},"docker.io":{"Mirrors":["https://hub-mirror.corp.example.com:5000/"],"Name":"docker.io","Official":true,"Secure":true},"registry.internal.corp.example.com:3000":{"Mirrors":[],"Name":"registry.internal.corp.example.com:3000","Official":false,"Secure":false}}

InsecureRegistryCIDRs

array[string]

optional

List of IP ranges of insecure registries, using the CIDR syntax
(RFC 4632). Insecure registries
accept un-encrypted (HTTP) and/or untrusted (HTTPS with certificates
from unknown CAs) communication.

By default, local registries (127.0.0.0/8) are configured as
insecure. All other registries are secure. Communicating with an
insecure registry is not possible if the daemon assumes that registry
is secure.

This configuration override this behavior, insecure communication with
registries whose resolved IP address is within the subnet described by
the CIDR syntax.

Registries can also be marked insecure by hostname. Those registries
are listed under IndexConfigs and have their Secure field set to
false.

Warning: Using this option can be useful when running a local
registry, but introduces security vulnerabilities. This option
should therefore ONLY be used for testing purposes. For increased
security, users should add their CA to their system's list of trusted
CAs instead of enabling this option.

Example:

["::1/128","127.0.0.0/8"]

Mirrors

array[string]

optional

List of registry URLs that act as a mirror for the official
(docker.io) registry.

Example:

["https://hub-mirror.corp.example.com:5000/","https://[2001:db8:a0b:12f0::1]/"]

RuncCommit

object (Commit)

optional

Commit holds the Git-commit (SHA1) that a binary was built from, as
reported in the version-string of external tools, such as containerd,
or runC.

Runtimes

object

optional

List of OCI compliant
runtimes configured on the daemon. Keys hold the "name" used to
reference the runtime.

The Docker daemon relies on an OCI compliant runtime (invoked via the
containerd daemon) as its interface to the Linux kernel namespaces,
cgroups, and SELinux.

The default runtime is runc, and automatically configured. Additional
runtimes can be configured by the user and will be listed here.

Default:

{"runc":{"path":"docker-runc"}}

Example:

{"custom":{"path":"/usr/local/bin/my-oci-runtime","runtimeArgs":["--debug","--systemd-cgroup=false"]},"runc":{"path":"docker-runc"},"runc-master":{"path":"/go/bin/runc"}}

Additional properties

object (Runtime)

optional

Runtime describes an OCI compliant
runtime.

The runtime is invoked by the daemon via the containerd daemon. OCI
runtimes act as an interface to the Linux kernel namespaces, cgroups,
and SELinux.

SecurityOptions

array[string]

optional

List of security features that are enabled on the daemon, such as
apparmor, seccomp, SELinux, and user-namespaces (userns).

Additional configuration options for each security feature may
be present, and are included as a comma-separated list of key/value
pairs.

Example:

["name=apparmor","name=seccomp,profile=default","name=selinux","name=userns"]

ServerVersion

string

optional

Version string of the daemon.

Note: the standalone Swarm API
returns the Swarm version instead of the daemon version, for example
swarm/1.2.8.

Example:

17.06.0-ce

SwapLimit

boolean

optional

Indicates if the host has memory swap limit support enabled.

Example:

true

Swarm

object (SwarmInfo)

optional

Represents generic information about swarm.

Cluster

object (ClusterInfo) | null

optional

ClusterInfo represents information about the swarm as is returned by the
"/info" endpoint. Join-tokens are not included.

ControlAvailable

boolean

optional

Default:

false

Example:

true

Error

string

optional

Default:

LocalNodeState

enum<string>

optional

Current local status of this node.

Allowed values:

inactivependingactiveerrorlocked

Default:

Example:

active

Managers

integer | null

optional

Total number of managers in the swarm.

Example:

NodeAddr

string

optional

IP address at which this node can be reached by other nodes in the
swarm.

Default:

Example:

10.0.0.46

NodeID

string

optional

Unique identifier of for this node in the swarm.

Default:

Example:

k67qz4598weg5unwwffg6z1m1

Nodes

integer | null

optional

Total number of nodes in the swarm.

Example:

RemoteManagers

array[object (PeerNode) {2}] | null

optional

List of ID's and addresses of other managers in the swarm.

Default:

null

Example:

[{"Addr":"10.0.0.158:2377","NodeID":"71izy0goik036k48jg985xnds"},{"Addr":"10.0.0.159:2377","NodeID":"79y6h1o4gv8n120drcprv5nmc"},{"Addr":"10.0.0.46:2377","NodeID":"k67qz4598weg5unwwffg6z1m1"}]

SystemStatus

array [array]

optional

Status information about this node (standalone Swarm API).

Note: The information returned in this field is only propagated
by the Swarm standalone API, and is empty (null) when using
built-in swarm mode.

Example:

[["Role","primary"],["State","Healthy"],["Strategy","spread"],["Filters","health, port, containerslots, dependency, affinity, constraint, whitelist"],["Nodes","2"],[" swarm-agent-00","192.168.99.102:2376"],[" └ ID","5CT6:FBGO:RVGO:CZL4:PB2K:WCYN:2JSV:KSHH:GGFW:QOPG:6J5Q:IOZ2|192.168.99.102:2376"],[" └ Status","Healthy"],[" └ Containers","1 (1 Running, 0 Paused, 0 Stopped)"],[" └ Reserved CPUs","0 / 1"],[" └ Reserved Memory","0 B / 1.021 GiB"],[" └ Labels","kernelversion=4.4.74-boot2docker, operatingsystem=Boot2Docker 17.06.0-ce (TCL 7.2); HEAD : 0672754 - Thu Jun 29 00:06:31 UTC 2017, ostype=linux, provider=virtualbox, storagedriver=aufs"],[" └ UpdatedAt","2017-08-09T10:03:46Z"],[" └ ServerVersion","17.06.0-ce"],[" swarm-manager","192.168.99.101:2376"],[" └ ID","TAMD:7LL3:SEF7:LW2W:4Q2X:WVFH:RTXX:JSYS:XY2P:JEHL:ZMJK:JGIW|192.168.99.101:2376"],[" └ Status","Healthy"],[" └ Containers","2 (2 Running, 0 Paused, 0 Stopped)"],[" └ Reserved CPUs","0 / 1"],[" └ Reserved Memory","0 B / 1.021 GiB"],[" └ Labels","kernelversion=4.4.74-boot2docker, operatingsystem=Boot2Docker 17.06.0-ce (TCL 7.2); HEAD : 0672754 - Thu Jun 29 00:06:31 UTC 2017, ostype=linux, provider=virtualbox, storagedriver=aufs"],[" └ UpdatedAt","2017-08-09T10:04:11Z"],[" └ ServerVersion","17.06.0-ce"]]

string

optional

SystemTime

string

optional

Current system-time in RFC 3339
format with nano-seconds.

Example:

2017-08-08T20:28:29.06202363Z

Request

Responses