Schema
Type:
object
Architecture
Type:
string
Hardware architecture of the host, as returned by the operating system.
This is equivalent to the output of uname -m on Linux.
Unlike Arch (from /version), this reports the machine's native
architecture, which can differ from the Go runtime architecture when
running a binary compiled for a different architecture (for example,
a 32-bit binary running on 64-bit hardware).
All schema constraints and annotations
{
"description": "Hardware architecture of the host, as returned by the operating system.\nThis is equivalent to the output of `uname -m` on Linux.\n\nUnlike `Arch` (from `/version`), this reports the machine's native\narchitecture, which can differ from the Go runtime architecture when\nrunning a binary compiled for a different architecture (for example,\na 32-bit binary running on 64-bit hardware).\n",
"example": "x86_64",
"type": "string"
}CDISpecDirs
Type:
array
List of directories where (Container Device Interface) CDI specifications are located.
These specifications define vendor-specific modifications to an OCI runtime specification for a container being created.
An empty list indicates that CDI device injection is disabled.
Note that since using CDI device injection requires the daemon to have experimental enabled. For non-experimental daemons an empty list will always be returned.
Array item
Type:
string
All schema constraints and annotations
{
"type": "string"
}All schema constraints and annotations
{
"description": "List of directories where (Container Device Interface) CDI\nspecifications are located.\n\nThese specifications define vendor-specific modifications to an OCI\nruntime specification for a container being created.\n\nAn empty list indicates that CDI device injection is disabled.\n\nNote that since using CDI device injection requires the daemon to have\nexperimental enabled. For non-experimental daemons an empty list will\nalways be returned.\n",
"example": [
"/etc/cdi",
"/var/run/cdi"
],
"items": {
"type": "string"
},
"type": "array"
}CPUSet
Type:
boolean
Indicates if CPUsets (cpuset.cpus, cpuset.mems) are supported by the host.
See cpuset(7)
All schema constraints and annotations
{
"description": "Indicates if CPUsets (cpuset.cpus, cpuset.mems) are supported by the host.\n\nSee [cpuset(7)](https://www.kernel.org/doc/Documentation/cgroup-v1/cpusets.txt)\n",
"example": true,
"type": "boolean"
}CPUShares
Type:
boolean
All schema constraints and annotations
{
"description": "Indicates if CPU Shares limiting is supported by the host.\n",
"example": true,
"type": "boolean"
}CgroupDriver
Type:
string
All schema constraints and annotations
{
"default": "cgroupfs",
"description": "The driver to use for managing cgroups.\n",
"enum": [
"cgroupfs",
"systemd",
"none"
],
"example": "cgroupfs",
"type": "string"
}CgroupVersion
Type:
string
All schema constraints and annotations
{
"default": "1",
"description": "The version of the cgroup.\n",
"enum": [
"1",
"2"
],
"example": "1",
"type": "string"
}Containerd
Schema:
ContainerdInfo
ContainerdCommit
Schema:
Commit
Containers
Type:
integer
All schema constraints and annotations
{
"description": "Total number of containers on the host.",
"example": 14,
"type": "integer"
}ContainersPaused
Type:
integer
"paused".All schema constraints and annotations
{
"description": "Number of containers with status `\"paused\"`.\n",
"example": 1,
"type": "integer"
}ContainersRunning
Type:
integer
"running".All schema constraints and annotations
{
"description": "Number of containers with status `\"running\"`.\n",
"example": 3,
"type": "integer"
}ContainersStopped
Type:
integer
"stopped".All schema constraints and annotations
{
"description": "Number of containers with status `\"stopped\"`.\n",
"example": 10,
"type": "integer"
}CpuCfsPeriod
Type:
boolean
All schema constraints and annotations
{
"description": "Indicates if CPU CFS(Completely Fair Scheduler) period is supported by\nthe host.\n",
"example": true,
"type": "boolean"
}CpuCfsQuota
Type:
boolean
All schema constraints and annotations
{
"description": "Indicates if CPU CFS(Completely Fair Scheduler) quota is supported by\nthe host.\n",
"example": true,
"type": "boolean"
}Debug
Type:
boolean
All schema constraints and annotations
{
"description": "Indicates if the daemon is running in debug-mode / with debug-level\nlogging enabled.\n",
"example": true,
"type": "boolean"
}DefaultAddressPools
Type:
array
List of custom default address pools for local networks, which can be specified in the daemon.json file or dockerd option.
Example: a Base "10.10.0.0/16" with Size 24 will define the set of 256 10.10.[0-255].0/24 address pools.
Array item
Type:
object
Base
Type:
string
All schema constraints and annotations
{
"description": "The network address in CIDR format",
"example": "10.10.0.0/16",
"type": "string"
}Size
Type:
integer
All schema constraints and annotations
{
"description": "The network pool size",
"example": "24",
"type": "integer"
}All schema constraints and annotations
{
"properties": {
"Base": {
"description": "The network address in CIDR format",
"example": "10.10.0.0/16",
"type": "string"
},
"Size": {
"description": "The network pool size",
"example": "24",
"type": "integer"
}
},
"type": "object"
}All schema constraints and annotations
{
"description": "List of custom default address pools for local networks, which can be\nspecified in the daemon.json file or dockerd option.\n\nExample: a Base \"10.10.0.0/16\" with Size 24 will define the set of 256\n10.10.[0-255].0/24 address pools.\n",
"items": {
"properties": {
"Base": {
"description": "The network address in CIDR format",
"example": "10.10.0.0/16",
"type": "string"
},
"Size": {
"description": "The network pool size",
"example": "24",
"type": "integer"
}
},
"type": "object"
},
"type": "array"
}DefaultRuntime
Type:
string
Name of the default OCI runtime that is used when starting containers.
The default can be overridden per-container at create time.
All schema constraints and annotations
{
"default": "runc",
"description": "Name of the default OCI runtime that is used when starting containers.\n\nThe default can be overridden per-container at create time.\n",
"example": "runc",
"type": "string"
}DiscoveredDevices
Type:
array
List of devices discovered by device drivers.
Each device includes information about its source driver, kind, name, and additional driver-specific attributes.
Array item
Schema:
DeviceInfo
All schema constraints and annotations
{
"description": "List of devices discovered by device drivers.\n\nEach device includes information about its source driver, kind, name,\nand additional driver-specific attributes.\n",
"items": {
"$ref": "#/components/schemas/DeviceInfo"
},
"type": "array"
}DockerRootDir
Type:
string
Root directory of persistent Docker state.
Defaults to /var/lib/docker on Linux, and C:\ProgramData\docker
on Windows.
All schema constraints and annotations
{
"description": "Root directory of persistent Docker state.\n\nDefaults to `/var/lib/docker` on Linux, and `C:\\ProgramData\\docker`\non Windows.\n",
"example": "/var/lib/docker",
"type": "string"
}Driver
Type:
string
All schema constraints and annotations
{
"description": "Name of the storage driver in use.",
"example": "overlay2",
"type": "string"
}DriverStatus
Type:
array
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.
Array item
Type:
array
Array item
Type:
string
All schema constraints and annotations
{
"type": "string"
}All schema constraints and annotations
{
"items": {
"type": "string"
},
"type": "array"
}All schema constraints and annotations
{
"description": "Information specific to the storage driver, provided as\n\"label\" / \"value\" pairs.\n\nThis information is provided by the storage driver, and formatted\nin a way consistent with the output of `docker info` on the command\nline.\n\n\u003cp\u003e\u003cbr /\u003e\u003c/p\u003e\n\n\u003e **Note**: The information returned in this field, including the\n\u003e formatting of values and labels, should not be considered stable,\n\u003e and may change without notice.\n",
"example": [
[
"Backing Filesystem",
"extfs"
],
[
"Supports d_type",
"true"
],
[
"Native Overlay Diff",
"true"
]
],
"items": {
"items": {
"type": "string"
},
"type": "array"
},
"type": "array"
}ExperimentalBuild
Type:
boolean
All schema constraints and annotations
{
"description": "Indicates if experimental features are enabled on the daemon.\n",
"example": true,
"type": "boolean"
}FirewallBackend
Schema:
FirewallInfo
GenericResources
Schema:
GenericResources
HttpProxy
Type:
string
HTTP-proxy configured for the daemon. This value is obtained from the
HTTP_PROXY environment variable.
Credentials (user info component) in the proxy URL
are masked in the API response.
Containers do not automatically inherit this configuration.
All schema constraints and annotations
{
"description": "HTTP-proxy configured for the daemon. This value is obtained from the\n[`HTTP_PROXY`](https://www.gnu.org/software/wget/manual/html_node/Proxies.html) environment variable.\nCredentials ([user info component](https://tools.ietf.org/html/rfc3986#section-3.2.1)) in the proxy URL\nare masked in the API response.\n\nContainers do not automatically inherit this configuration.\n",
"example": "http://xxxxx:xxxxx@proxy.corp.example.com:8080",
"type": "string"
}HttpsProxy
Type:
string
HTTPS-proxy configured for the daemon. This value is obtained from the
HTTPS_PROXY environment variable.
Credentials (user info component) in the proxy URL
are masked in the API response.
Containers do not automatically inherit this configuration.
All schema constraints and annotations
{
"description": "HTTPS-proxy configured for the daemon. This value is obtained from the\n[`HTTPS_PROXY`](https://www.gnu.org/software/wget/manual/html_node/Proxies.html) environment variable.\nCredentials ([user info component](https://tools.ietf.org/html/rfc3986#section-3.2.1)) in the proxy URL\nare masked in the API response.\n\nContainers do not automatically inherit this configuration.\n",
"example": "https://xxxxx:xxxxx@proxy.corp.example.com:4443",
"type": "string"
}ID
Type:
string
Unique identifier of the daemon.
Note: The format of the ID itself is not part of the API, and should not be considered stable.
All schema constraints and annotations
{
"description": "Unique identifier of the daemon.\n\n\u003cp\u003e\u003cbr /\u003e\u003c/p\u003e\n\n\u003e **Note**: The format of the ID itself is not part of the API, and\n\u003e should not be considered stable.\n",
"example": "7TRN:IPZB:QYBB:VPBQ:UMPP:KARE:6ZNR:XE6T:7EWV:PKF4:ZOJD:TPYS",
"type": "string"
}IPv4Forwarding
Type:
boolean
All schema constraints and annotations
{
"description": "Indicates IPv4 forwarding is enabled.",
"example": true,
"type": "boolean"
}Images
Type:
integer
Total number of images on the host.
Both tagged and untagged (dangling) images are counted.
All schema constraints and annotations
{
"description": "Total number of images on the host.\n\nBoth _tagged_ and _untagged_ (dangling) images are counted.\n",
"example": 508,
"type": "integer"
}IndexServerAddress
Type:
string
All schema constraints and annotations
{
"default": "https://index.docker.io/v1/",
"description": "Address / URL of the index server that is used for image search,\nand as a default for user authentication for Docker Hub and Docker Cloud.\n",
"example": "https://index.docker.io/v1/",
"type": "string"
}InitBinary
Type:
string
Name and, optional, path of the docker-init binary.
If the path is omitted, the daemon searches the host's $PATH for the
binary and uses the first result.
All schema constraints and annotations
{
"description": "Name and, optional, path of the `docker-init` binary.\n\nIf the path is omitted, the daemon searches the host's `$PATH` for the\nbinary and uses the first result.\n",
"example": "docker-init",
"type": "string"
}InitCommit
Schema:
Commit
Isolation
Type:
string
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.
All schema constraints and annotations
{
"default": "default",
"description": "Represents the isolation technology to use as a default for containers.\nThe supported values are platform-specific.\n\nIf no isolation value is specified on daemon start, on Windows client,\nthe default is `hyperv`, and on Windows server, the default is `process`.\n\nThis option is currently not used on other platforms.\n",
"enum": [
"default",
"hyperv",
"process",
""
],
"type": "string"
}KernelVersion
Type:
string
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)".
All schema constraints and annotations
{
"description": "Kernel version of the host.\n\nOn Linux, this information obtained from `uname`. On Windows this\ninformation is queried from the \u003ckbd\u003eHKEY_LOCAL_MACHINE\\\\SOFTWARE\\\\Microsoft\\\\Windows NT\\\\CurrentVersion\\\\\u003c/kbd\u003e\nregistry value, for example _\"10.0 14393 (14393.1198.amd64fre.rs1_release_sec.170427-1353)\"_.\n",
"example": "6.8.0-31-generic",
"type": "string"
}Labels
Type:
array
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.
Array item
Type:
string
All schema constraints and annotations
{
"type": "string"
}All schema constraints and annotations
{
"description": "User-defined labels (key/value metadata) as set on the daemon.\n\n\u003cp\u003e\u003cbr /\u003e\u003c/p\u003e\n\n\u003e **Note**: When part of a Swarm, nodes can both have _daemon_ labels,\n\u003e set through the daemon configuration, and _node_ labels, set from a\n\u003e manager node in the Swarm. Node labels are not included in this\n\u003e field. Node labels can be retrieved using the `/nodes/(id)` endpoint\n\u003e on a manager node in the Swarm.\n",
"example": [
"storage=ssd",
"production"
],
"items": {
"type": "string"
},
"type": "array"
}LiveRestoreEnabled
Type:
boolean
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.
All schema constraints and annotations
{
"default": false,
"description": "Indicates if live restore is enabled.\n\nIf enabled, containers are kept running when the daemon is shutdown\nor upon daemon start if running containers are detected.\n",
"example": false,
"type": "boolean"
}LoggingDriver
Type:
string
All schema constraints and annotations
{
"description": "The logging driver to use as a default for new containers.\n",
"type": "string"
}MemTotal
Type:
integer
All schema constraints and annotations
{
"description": "Total amount of physical memory available on the host, in bytes.\n",
"example": 2095882240,
"format": "int64",
"type": "integer"
}MemoryLimit
Type:
boolean
All schema constraints and annotations
{
"description": "Indicates if the host has memory limit support enabled.",
"example": true,
"type": "boolean"
}NCPU
Type:
integer
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.
All schema constraints and annotations
{
"description": "The number of logical CPUs usable by the daemon.\n\nThe number of available CPUs is checked by querying the operating\nsystem when the daemon starts. Changes to operating system CPU\nallocation after the daemon is started are not reflected.\n",
"example": 4,
"type": "integer"
}NEventsListener
Type:
integer
All schema constraints and annotations
{
"description": "Number of event listeners subscribed.",
"example": 30,
"type": "integer"
}NFd
Type:
integer
The total number of file Descriptors in use by the daemon process.
This information is only returned if debug-mode is enabled.
All schema constraints and annotations
{
"description": "The total number of file Descriptors in use by the daemon process.\n\nThis information is only returned if debug-mode is enabled.\n",
"example": 64,
"type": "integer"
}NGoroutines
Type:
integer
The number of goroutines that currently exist.
This information is only returned if debug-mode is enabled.
All schema constraints and annotations
{
"description": "The number of goroutines that currently exist.\n\nThis information is only returned if debug-mode is enabled.\n",
"example": 174,
"type": "integer"
}NRI
Schema:
NRIInfo
Name
Type:
string
All schema constraints and annotations
{
"description": "Hostname of the host.",
"example": "node5.corp.example.com",
"type": "string"
}NoProxy
Type:
string
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.
All schema constraints and annotations
{
"description": "Comma-separated list of domain extensions for which no proxy should be\nused. This value is obtained from the [`NO_PROXY`](https://www.gnu.org/software/wget/manual/html_node/Proxies.html)\nenvironment variable.\n\nContainers do not automatically inherit this configuration.\n",
"example": "*.local, 169.254/16",
"type": "string"
}OSType
Type:
string
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.
All schema constraints and annotations
{
"description": "Generic type of the operating system of the host, as returned by the\nGo runtime (`GOOS`).\n\nCurrently returned values are \"linux\" and \"windows\". A full list of\npossible values can be found in the [Go documentation](https://go.dev/doc/install/source#environment).\n",
"example": "linux",
"type": "string"
}OSVersion
Type:
string
Version of the host's operating system
Note: The information returned in this field, including its very existence, and the formatting of values, should not be considered stable, and may change without notice.
All schema constraints and annotations
{
"description": "Version of the host's operating system\n\n\u003cp\u003e\u003cbr /\u003e\u003c/p\u003e\n\n\u003e **Note**: The information returned in this field, including its\n\u003e very existence, and the formatting of values, should not be considered\n\u003e stable, and may change without notice.\n",
"example": "24.04",
"type": "string"
}OomKillDisable
Type:
boolean
All schema constraints and annotations
{
"description": "Indicates if OOM killer disable is supported on the host.",
"type": "boolean"
}OperatingSystem
Type:
string
All schema constraints and annotations
{
"description": "Name of the host's operating system, for example: \"Ubuntu 24.04 LTS\"\nor \"Windows Server 2016 Datacenter\"\n",
"example": "Ubuntu 24.04 LTS",
"type": "string"
}PidsLimit
Type:
boolean
All schema constraints and annotations
{
"description": "Indicates if the host kernel has PID limit support enabled.",
"example": true,
"type": "boolean"
}Plugins
Schema:
PluginsInfo
ProductLicense
Type:
string
Reports a summary of the product license on the daemon.
If a commercial license has been applied to the daemon, information such as number of nodes, and expiration are included.
All schema constraints and annotations
{
"description": "Reports a summary of the product license on the daemon.\n\nIf a commercial license has been applied to the daemon, information\nsuch as number of nodes, and expiration are included.\n",
"example": "Community Engine",
"type": "string"
}RegistryConfig
Schema:
RegistryServiceConfig
RuncCommit
Schema:
Commit
Runtimes
Type:
object
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.
All schema constraints and annotations
{
"additionalProperties": {
"$ref": "#/components/schemas/Runtime"
},
"default": {
"runc": {
"path": "runc"
}
},
"description": "List of [OCI compliant](https://github.com/opencontainers/runtime-spec)\nruntimes configured on the daemon. Keys hold the \"name\" used to\nreference the runtime.\n\nThe Docker daemon relies on an OCI compliant runtime (invoked via the\n`containerd` daemon) as its interface to the Linux kernel namespaces,\ncgroups, and SELinux.\n\nThe default runtime is `runc`, and automatically configured. Additional\nruntimes can be configured by the user and will be listed here.\n",
"example": {
"custom": {
"path": "/usr/local/bin/my-oci-runtime",
"runtimeArgs": [
"--debug",
"--systemd-cgroup=false"
]
},
"runc": {
"path": "runc"
},
"runc-master": {
"path": "/go/bin/runc"
}
},
"type": "object"
}SecurityOptions
Type:
array
List of security features that are enabled on the daemon, such as apparmor, seccomp, SELinux, user-namespaces (userns), rootless and no-new-privileges.
Additional configuration options for each security feature may be present, and are included as a comma-separated list of key/value pairs.
Array item
Type:
string
All schema constraints and annotations
{
"type": "string"
}All schema constraints and annotations
{
"description": "List of security features that are enabled on the daemon, such as\napparmor, seccomp, SELinux, user-namespaces (userns), rootless and\nno-new-privileges.\n\nAdditional configuration options for each security feature may\nbe present, and are included as a comma-separated list of key/value\npairs.\n",
"example": [
"name=apparmor",
"name=seccomp,profile=default",
"name=selinux",
"name=userns",
"name=rootless"
],
"items": {
"type": "string"
},
"type": "array"
}ServerVersion
Type:
string
All schema constraints and annotations
{
"description": "Version string of the daemon.\n",
"example": "27.0.1",
"type": "string"
}SwapLimit
Type:
boolean
All schema constraints and annotations
{
"description": "Indicates if the host has memory swap limit support enabled.",
"example": true,
"type": "boolean"
}Swarm
Schema:
SwarmInfo
SystemTime
Type:
string
All schema constraints and annotations
{
"description": "Current system-time in [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt)\nformat with nano-seconds.\n",
"example": "2017-08-08T20:28:29.06202363Z",
"type": "string"
}Warnings
Type:
array
List of warnings / informational messages about missing features, or issues related to the daemon configuration.
These messages can be printed by the client as information to the user.
Array item
Type:
string
All schema constraints and annotations
{
"type": "string"
}All schema constraints and annotations
{
"description": "List of warnings / informational messages about missing features, or\nissues related to the daemon configuration.\n\nThese messages can be printed by the client as information to the user.\n",
"example": [
"WARNING: No memory limit support"
],
"items": {
"type": "string"
},
"type": "array"
}All schema constraints and annotations
{
"properties": {
"Architecture": {
"description": "Hardware architecture of the host, as returned by the operating system.\nThis is equivalent to the output of `uname -m` on Linux.\n\nUnlike `Arch` (from `/version`), this reports the machine's native\narchitecture, which can differ from the Go runtime architecture when\nrunning a binary compiled for a different architecture (for example,\na 32-bit binary running on 64-bit hardware).\n",
"example": "x86_64",
"type": "string"
},
"CDISpecDirs": {
"description": "List of directories where (Container Device Interface) CDI\nspecifications are located.\n\nThese specifications define vendor-specific modifications to an OCI\nruntime specification for a container being created.\n\nAn empty list indicates that CDI device injection is disabled.\n\nNote that since using CDI device injection requires the daemon to have\nexperimental enabled. For non-experimental daemons an empty list will\nalways be returned.\n",
"example": [
"/etc/cdi",
"/var/run/cdi"
],
"items": {
"type": "string"
},
"type": "array"
},
"CPUSet": {
"description": "Indicates if CPUsets (cpuset.cpus, cpuset.mems) are supported by the host.\n\nSee [cpuset(7)](https://www.kernel.org/doc/Documentation/cgroup-v1/cpusets.txt)\n",
"example": true,
"type": "boolean"
},
"CPUShares": {
"description": "Indicates if CPU Shares limiting is supported by the host.\n",
"example": true,
"type": "boolean"
},
"CgroupDriver": {
"default": "cgroupfs",
"description": "The driver to use for managing cgroups.\n",
"enum": [
"cgroupfs",
"systemd",
"none"
],
"example": "cgroupfs",
"type": "string"
},
"CgroupVersion": {
"default": "1",
"description": "The version of the cgroup.\n",
"enum": [
"1",
"2"
],
"example": "1",
"type": "string"
},
"Containerd": {
"$ref": "#/components/schemas/ContainerdInfo"
},
"ContainerdCommit": {
"$ref": "#/components/schemas/Commit"
},
"Containers": {
"description": "Total number of containers on the host.",
"example": 14,
"type": "integer"
},
"ContainersPaused": {
"description": "Number of containers with status `\"paused\"`.\n",
"example": 1,
"type": "integer"
},
"ContainersRunning": {
"description": "Number of containers with status `\"running\"`.\n",
"example": 3,
"type": "integer"
},
"ContainersStopped": {
"description": "Number of containers with status `\"stopped\"`.\n",
"example": 10,
"type": "integer"
},
"CpuCfsPeriod": {
"description": "Indicates if CPU CFS(Completely Fair Scheduler) period is supported by\nthe host.\n",
"example": true,
"type": "boolean"
},
"CpuCfsQuota": {
"description": "Indicates if CPU CFS(Completely Fair Scheduler) quota is supported by\nthe host.\n",
"example": true,
"type": "boolean"
},
"Debug": {
"description": "Indicates if the daemon is running in debug-mode / with debug-level\nlogging enabled.\n",
"example": true,
"type": "boolean"
},
"DefaultAddressPools": {
"description": "List of custom default address pools for local networks, which can be\nspecified in the daemon.json file or dockerd option.\n\nExample: a Base \"10.10.0.0/16\" with Size 24 will define the set of 256\n10.10.[0-255].0/24 address pools.\n",
"items": {
"properties": {
"Base": {
"description": "The network address in CIDR format",
"example": "10.10.0.0/16",
"type": "string"
},
"Size": {
"description": "The network pool size",
"example": "24",
"type": "integer"
}
},
"type": "object"
},
"type": "array"
},
"DefaultRuntime": {
"default": "runc",
"description": "Name of the default OCI runtime that is used when starting containers.\n\nThe default can be overridden per-container at create time.\n",
"example": "runc",
"type": "string"
},
"DiscoveredDevices": {
"description": "List of devices discovered by device drivers.\n\nEach device includes information about its source driver, kind, name,\nand additional driver-specific attributes.\n",
"items": {
"$ref": "#/components/schemas/DeviceInfo"
},
"type": "array"
},
"DockerRootDir": {
"description": "Root directory of persistent Docker state.\n\nDefaults to `/var/lib/docker` on Linux, and `C:\\ProgramData\\docker`\non Windows.\n",
"example": "/var/lib/docker",
"type": "string"
},
"Driver": {
"description": "Name of the storage driver in use.",
"example": "overlay2",
"type": "string"
},
"DriverStatus": {
"description": "Information specific to the storage driver, provided as\n\"label\" / \"value\" pairs.\n\nThis information is provided by the storage driver, and formatted\nin a way consistent with the output of `docker info` on the command\nline.\n\n\u003cp\u003e\u003cbr /\u003e\u003c/p\u003e\n\n\u003e **Note**: The information returned in this field, including the\n\u003e formatting of values and labels, should not be considered stable,\n\u003e and may change without notice.\n",
"example": [
[
"Backing Filesystem",
"extfs"
],
[
"Supports d_type",
"true"
],
[
"Native Overlay Diff",
"true"
]
],
"items": {
"items": {
"type": "string"
},
"type": "array"
},
"type": "array"
},
"ExperimentalBuild": {
"description": "Indicates if experimental features are enabled on the daemon.\n",
"example": true,
"type": "boolean"
},
"FirewallBackend": {
"$ref": "#/components/schemas/FirewallInfo"
},
"GenericResources": {
"$ref": "#/components/schemas/GenericResources"
},
"HttpProxy": {
"description": "HTTP-proxy configured for the daemon. This value is obtained from the\n[`HTTP_PROXY`](https://www.gnu.org/software/wget/manual/html_node/Proxies.html) environment variable.\nCredentials ([user info component](https://tools.ietf.org/html/rfc3986#section-3.2.1)) in the proxy URL\nare masked in the API response.\n\nContainers do not automatically inherit this configuration.\n",
"example": "http://xxxxx:xxxxx@proxy.corp.example.com:8080",
"type": "string"
},
"HttpsProxy": {
"description": "HTTPS-proxy configured for the daemon. This value is obtained from the\n[`HTTPS_PROXY`](https://www.gnu.org/software/wget/manual/html_node/Proxies.html) environment variable.\nCredentials ([user info component](https://tools.ietf.org/html/rfc3986#section-3.2.1)) in the proxy URL\nare masked in the API response.\n\nContainers do not automatically inherit this configuration.\n",
"example": "https://xxxxx:xxxxx@proxy.corp.example.com:4443",
"type": "string"
},
"ID": {
"description": "Unique identifier of the daemon.\n\n\u003cp\u003e\u003cbr /\u003e\u003c/p\u003e\n\n\u003e **Note**: The format of the ID itself is not part of the API, and\n\u003e should not be considered stable.\n",
"example": "7TRN:IPZB:QYBB:VPBQ:UMPP:KARE:6ZNR:XE6T:7EWV:PKF4:ZOJD:TPYS",
"type": "string"
},
"IPv4Forwarding": {
"description": "Indicates IPv4 forwarding is enabled.",
"example": true,
"type": "boolean"
},
"Images": {
"description": "Total number of images on the host.\n\nBoth _tagged_ and _untagged_ (dangling) images are counted.\n",
"example": 508,
"type": "integer"
},
"IndexServerAddress": {
"default": "https://index.docker.io/v1/",
"description": "Address / URL of the index server that is used for image search,\nand as a default for user authentication for Docker Hub and Docker Cloud.\n",
"example": "https://index.docker.io/v1/",
"type": "string"
},
"InitBinary": {
"description": "Name and, optional, path of the `docker-init` binary.\n\nIf the path is omitted, the daemon searches the host's `$PATH` for the\nbinary and uses the first result.\n",
"example": "docker-init",
"type": "string"
},
"InitCommit": {
"$ref": "#/components/schemas/Commit"
},
"Isolation": {
"default": "default",
"description": "Represents the isolation technology to use as a default for containers.\nThe supported values are platform-specific.\n\nIf no isolation value is specified on daemon start, on Windows client,\nthe default is `hyperv`, and on Windows server, the default is `process`.\n\nThis option is currently not used on other platforms.\n",
"enum": [
"default",
"hyperv",
"process",
""
],
"type": "string"
},
"KernelVersion": {
"description": "Kernel version of the host.\n\nOn Linux, this information obtained from `uname`. On Windows this\ninformation is queried from the \u003ckbd\u003eHKEY_LOCAL_MACHINE\\\\SOFTWARE\\\\Microsoft\\\\Windows NT\\\\CurrentVersion\\\\\u003c/kbd\u003e\nregistry value, for example _\"10.0 14393 (14393.1198.amd64fre.rs1_release_sec.170427-1353)\"_.\n",
"example": "6.8.0-31-generic",
"type": "string"
},
"Labels": {
"description": "User-defined labels (key/value metadata) as set on the daemon.\n\n\u003cp\u003e\u003cbr /\u003e\u003c/p\u003e\n\n\u003e **Note**: When part of a Swarm, nodes can both have _daemon_ labels,\n\u003e set through the daemon configuration, and _node_ labels, set from a\n\u003e manager node in the Swarm. Node labels are not included in this\n\u003e field. Node labels can be retrieved using the `/nodes/(id)` endpoint\n\u003e on a manager node in the Swarm.\n",
"example": [
"storage=ssd",
"production"
],
"items": {
"type": "string"
},
"type": "array"
},
"LiveRestoreEnabled": {
"default": false,
"description": "Indicates if live restore is enabled.\n\nIf enabled, containers are kept running when the daemon is shutdown\nor upon daemon start if running containers are detected.\n",
"example": false,
"type": "boolean"
},
"LoggingDriver": {
"description": "The logging driver to use as a default for new containers.\n",
"type": "string"
},
"MemTotal": {
"description": "Total amount of physical memory available on the host, in bytes.\n",
"example": 2095882240,
"format": "int64",
"type": "integer"
},
"MemoryLimit": {
"description": "Indicates if the host has memory limit support enabled.",
"example": true,
"type": "boolean"
},
"NCPU": {
"description": "The number of logical CPUs usable by the daemon.\n\nThe number of available CPUs is checked by querying the operating\nsystem when the daemon starts. Changes to operating system CPU\nallocation after the daemon is started are not reflected.\n",
"example": 4,
"type": "integer"
},
"NEventsListener": {
"description": "Number of event listeners subscribed.",
"example": 30,
"type": "integer"
},
"NFd": {
"description": "The total number of file Descriptors in use by the daemon process.\n\nThis information is only returned if debug-mode is enabled.\n",
"example": 64,
"type": "integer"
},
"NGoroutines": {
"description": "The number of goroutines that currently exist.\n\nThis information is only returned if debug-mode is enabled.\n",
"example": 174,
"type": "integer"
},
"NRI": {
"$ref": "#/components/schemas/NRIInfo"
},
"Name": {
"description": "Hostname of the host.",
"example": "node5.corp.example.com",
"type": "string"
},
"NoProxy": {
"description": "Comma-separated list of domain extensions for which no proxy should be\nused. This value is obtained from the [`NO_PROXY`](https://www.gnu.org/software/wget/manual/html_node/Proxies.html)\nenvironment variable.\n\nContainers do not automatically inherit this configuration.\n",
"example": "*.local, 169.254/16",
"type": "string"
},
"OSType": {
"description": "Generic type of the operating system of the host, as returned by the\nGo runtime (`GOOS`).\n\nCurrently returned values are \"linux\" and \"windows\". A full list of\npossible values can be found in the [Go documentation](https://go.dev/doc/install/source#environment).\n",
"example": "linux",
"type": "string"
},
"OSVersion": {
"description": "Version of the host's operating system\n\n\u003cp\u003e\u003cbr /\u003e\u003c/p\u003e\n\n\u003e **Note**: The information returned in this field, including its\n\u003e very existence, and the formatting of values, should not be considered\n\u003e stable, and may change without notice.\n",
"example": "24.04",
"type": "string"
},
"OomKillDisable": {
"description": "Indicates if OOM killer disable is supported on the host.",
"type": "boolean"
},
"OperatingSystem": {
"description": "Name of the host's operating system, for example: \"Ubuntu 24.04 LTS\"\nor \"Windows Server 2016 Datacenter\"\n",
"example": "Ubuntu 24.04 LTS",
"type": "string"
},
"PidsLimit": {
"description": "Indicates if the host kernel has PID limit support enabled.",
"example": true,
"type": "boolean"
},
"Plugins": {
"$ref": "#/components/schemas/PluginsInfo"
},
"ProductLicense": {
"description": "Reports a summary of the product license on the daemon.\n\nIf a commercial license has been applied to the daemon, information\nsuch as number of nodes, and expiration are included.\n",
"example": "Community Engine",
"type": "string"
},
"RegistryConfig": {
"$ref": "#/components/schemas/RegistryServiceConfig"
},
"RuncCommit": {
"$ref": "#/components/schemas/Commit"
},
"Runtimes": {
"additionalProperties": {
"$ref": "#/components/schemas/Runtime"
},
"default": {
"runc": {
"path": "runc"
}
},
"description": "List of [OCI compliant](https://github.com/opencontainers/runtime-spec)\nruntimes configured on the daemon. Keys hold the \"name\" used to\nreference the runtime.\n\nThe Docker daemon relies on an OCI compliant runtime (invoked via the\n`containerd` daemon) as its interface to the Linux kernel namespaces,\ncgroups, and SELinux.\n\nThe default runtime is `runc`, and automatically configured. Additional\nruntimes can be configured by the user and will be listed here.\n",
"example": {
"custom": {
"path": "/usr/local/bin/my-oci-runtime",
"runtimeArgs": [
"--debug",
"--systemd-cgroup=false"
]
},
"runc": {
"path": "runc"
},
"runc-master": {
"path": "/go/bin/runc"
}
},
"type": "object"
},
"SecurityOptions": {
"description": "List of security features that are enabled on the daemon, such as\napparmor, seccomp, SELinux, user-namespaces (userns), rootless and\nno-new-privileges.\n\nAdditional configuration options for each security feature may\nbe present, and are included as a comma-separated list of key/value\npairs.\n",
"example": [
"name=apparmor",
"name=seccomp,profile=default",
"name=selinux",
"name=userns",
"name=rootless"
],
"items": {
"type": "string"
},
"type": "array"
},
"ServerVersion": {
"description": "Version string of the daemon.\n",
"example": "27.0.1",
"type": "string"
},
"SwapLimit": {
"description": "Indicates if the host has memory swap limit support enabled.",
"example": true,
"type": "boolean"
},
"Swarm": {
"$ref": "#/components/schemas/SwarmInfo"
},
"SystemTime": {
"description": "Current system-time in [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt)\nformat with nano-seconds.\n",
"example": "2017-08-08T20:28:29.06202363Z",
"type": "string"
},
"Warnings": {
"description": "List of warnings / informational messages about missing features, or\nissues related to the daemon configuration.\n\nThese messages can be printed by the client as information to the user.\n",
"example": [
"WARNING: No memory limit support"
],
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
}