v1

latestSwagger 2.02026-07-17107114423.2 KB
System

Get system information

get/info

Response

No error

IDstring

Unique identifier of the daemon.

<p><br /></p>

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

Containersinteger

Total number of containers on the host.

ContainersRunninginteger

Number of containers with status "running".

ContainersPausedinteger

Number of containers with status "paused".

ContainersStoppedinteger

Number of containers with status "stopped".

Imagesinteger

Total number of images on the host.

Both tagged and untagged (dangling) images are counted.

Driverstring

Name of the storage driver in use.

DockerRootDirstring

Root directory of persistent Docker state.

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

MemoryLimitboolean

Indicates if the host has memory limit support enabled.

SwapLimitboolean

Indicates if the host has memory swap limit support enabled.

KernelMemoryTCPboolean

Indicates if the host has kernel memory TCP limit support enabled. This field is omitted if not supported.

Kernel memory TCP limits are not supported when using cgroups v2, which does not support the corresponding memory.kmem.tcp.limit_in_bytes cgroup.

CpuCfsPeriodboolean

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

CpuCfsQuotaboolean

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

CPUSharesboolean

Indicates if CPU Shares limiting is supported by the host.

CPUSetboolean

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

See cpuset(7)

PidsLimitboolean

Indicates if the host kernel has PID limit support enabled.

OomKillDisableboolean

Indicates if OOM killer disable is supported on the host.

IPv4Forwardingboolean

Indicates IPv4 forwarding is enabled.

BridgeNfIptablesboolean

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

BridgeNfIp6tablesboolean

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

Debugboolean

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

NFdinteger

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

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

NGoroutinesinteger

The number of goroutines that currently exist.

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

SystemTimestring

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

LoggingDriverstring

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

CgroupDriver'cgroupfs' | 'systemd' | 'none'

The driver to use for managing cgroups.

CgroupVersion'1' | '2'

The version of the cgroup.

NEventsListenerinteger

Number of event listeners subscribed.

KernelVersionstring

Kernel version of the host.

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

OperatingSystemstring

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

OSVersionstring

Version of the host's operating system

<p><br /></p>

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.

OSTypestring

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.

Architecturestring

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.

NCPUinteger

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.

MemTotalinteger

Total amount of physical memory available on the host, in bytes.

IndexServerAddressstring

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.

HttpProxystring

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.

HttpsProxystring

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.

NoProxystring

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.

Namestring

Hostname of the host.

Labelsstring[]

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

<p><br /></p>

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.

ExperimentalBuildboolean

Indicates if experimental features are enabled on the daemon.

ServerVersionstring

Version string of the daemon.

Runtimesobject

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.

DefaultRuntimestring

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

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

LiveRestoreEnabledboolean

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.

Isolation'default' | 'hyperv' | 'process'

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.

InitBinarystring

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.

SecurityOptionsstring[]

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.

ProductLicensestring

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.

Warningsstring[]

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.

CDISpecDirsstring[]

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.

Example response

{
  "ID": "7TRN:IPZB:QYBB:VPBQ:UMPP:KARE:6ZNR:XE6T:7EWV:PKF4:ZOJD:TPYS",
  "Containers": 14,
  "ContainersRunning": 3,
  "ContainersPaused": 1,
  "ContainersStopped": 10,
  "Images": 508,
  "Driver": "overlay2",
  "DriverStatus": [
    [
      "Backing Filesystem",
      "extfs"
    ],
    [
      "Supports d_type",
      "true"
    ],
    [
      "Native Overlay Diff",
      "true"
    ]
  ],
  "DockerRootDir": "/var/lib/docker",
  "Plugins": {
    "Volume": [
      "local"
    ],
    "Network": [
      "bridge",
      "host",
      "ipvlan",
      "macvlan",
      "null",
      "overlay"
    ],
    "Authorization": [
      "img-authz-plugin",
      "hbm"
    ],
    "Log": [
      "awslogs",
      "fluentd",
      "gcplogs",
      "gelf",
      "journald",
      "json-file",
      "splunk",
      "syslog"
    ]
  },
  "MemoryLimit": true,
  "SwapLimit": true,
  "KernelMemoryTCP": true,
  "CpuCfsPeriod": true,
  "CpuCfsQuota": true,
  "CPUShares": true,
  "CPUSet": true,
  "PidsLimit": true,
  "IPv4Forwarding": true,
  "BridgeNfIptables": true,
  "BridgeNfIp6tables": true,
  "Debug": true,
  "NFd": 64,
  "NGoroutines": 174,
  "SystemTime": "2017-08-08T20:28:29.06202363Z",
  "CgroupDriver": "cgroupfs",
  "CgroupVersion": "1",
  "NEventsListener": 30,
  "KernelVersion": "6.8.0-31-generic",
  "OperatingSystem": "Ubuntu 24.04 LTS",
  "OSVersion": "24.04",
  "OSType": "linux",
  "Architecture": "x86_64",
  "NCPU": 4,
  "MemTotal": 2095882240,
  "IndexServerAddress": "https://index.docker.io/v1/",
  "RegistryConfig": {
    "AllowNondistributableArtifactsCIDRs": [
      "::1/128",
      "127.0.0.0/8"
    ],
    "AllowNondistributableArtifactsHostnames": [
      "registry.internal.corp.example.com:3000",
      "[2001:db8:a0b:12f0::1]:443"
    ],
    "InsecureRegistryCIDRs": [
      "::1/128",
      "127.0.0.0/8"
    ],
    "IndexConfigs": {
      "127.0.0.1:5000": {
        "Name": "127.0.0.1:5000",
        "Mirrors": [],
        "Secure": false,
        "Official": false
      },
      "[2001:db8:a0b:12f0::1]:80": {
        "Name": "[2001:db8:a0b:12f0::1]:80",
        "Mirrors": [],
        "Secure": false,
        "Official": false
      },
      "docker.io": {
        "Name": "docker.io",
        "Mirrors": [
          "https://hub-mirror.corp.example.com:5000/"
        ],
        "Secure": true,
        "Official": true
      },
      "registry.internal.corp.example.com:3000": {
        "Name": "registry.internal.corp.example.com:3000",
        "Mirrors": [],
        "Secure": false,
        "Official": false
      }
    },
    "Mirrors": [
      "https://hub-mirror.corp.example.com:5000/",
      "https://[2001:db8:a0b:12f0::1]/"
    ]
  },
  "GenericResources": [
    {
      "DiscreteResourceSpec": {
        "Kind": "SSD",
        "Value": 3
      }
    },
    {
      "NamedResourceSpec": {
        "Kind": "GPU",
        "Value": "UUID1"
      }
    },
    {
      "NamedResourceSpec": {
        "Kind": "GPU",
        "Value": "UUID2"
      }
    }
  ],
  "HttpProxy": "http://xxxxx:xxxxx@proxy.corp.example.com:8080",
  "HttpsProxy": "https://xxxxx:xxxxx@proxy.corp.example.com:4443",
  "NoProxy": "*.local, 169.254/16",
  "Name": "node5.corp.example.com",
  "Labels": [
    "storage=ssd",
    "production"
  ],
  "ExperimentalBuild": true,
  "ServerVersion": "27.0.1",
  "Runtimes": {
    "runc": {
      "path": "runc"
    },
    "runc-master": {
      "path": "/go/bin/runc"
    },
    "custom": {
      "path": "/usr/local/bin/my-oci-runtime",
      "runtimeArgs": [
        "--debug",
        "--systemd-cgroup=false"
      ]
    }
  },
  "DefaultRuntime": "runc",
  "Swarm": {
    "NodeID": "k67qz4598weg5unwwffg6z1m1",
    "NodeAddr": "10.0.0.46",
    "LocalNodeState": "active",
    "ControlAvailable": true,
    "RemoteManagers": [
      {
        "NodeID": "71izy0goik036k48jg985xnds",
        "Addr": "10.0.0.158:2377"
      },
      {
        "NodeID": "79y6h1o4gv8n120drcprv5nmc",
        "Addr": "10.0.0.159:2377"
      },
      {
        "NodeID": "k67qz4598weg5unwwffg6z1m1",
        "Addr": "10.0.0.46:2377"
      }
    ],
    "Nodes": 4,
    "Managers": 3,
    "Cluster": {
      "ID": "abajmipo7b4xz5ip2nrla6b11",
      "Version": {
        "Index": 373531
      },
      "CreatedAt": "2016-08-18T10:44:24.496525531Z",
      "UpdatedAt": "2017-08-09T07:09:37.632105588Z",
      "Spec": {
        "Name": "default",
        "Labels": {
          "com.example.corp.type": "production",
          "com.example.corp.department": "engineering"
        },
        "Orchestration": {
          "TaskHistoryRetentionLimit": 10
        },
        "Raft": {
          "SnapshotInterval": 10000,
          "LogEntriesForSlowFollowers": 500,
          "ElectionTick": 3,
          "HeartbeatTick": 1
        },
        "Dispatcher": {
          "HeartbeatPeriod": 5000000000
        },
        "CAConfig": {
          "NodeCertExpiry": 7776000000000000
        },
        "TaskDefaults": {
          "LogDriver": {
            "Name": "json-file",
            "Options": {
              "max-file": "10",
              "max-size": "100m"
            }
          }
        }
      },
      "TLSInfo": {
        "TrustRoot": "-----BEGIN CERTIFICATE-----\nMIIBajCCARCgAwIBAgIUbYqrLSOSQHoxD8CwG6Bi2PJi9c8wCgYIKoZIzj0EAwIw\nEzERMA8GA1UEAxMIc3dhcm0tY2EwHhcNMTcwNDI0MjE0MzAwWhcNMzcwNDE5MjE0\nMzAwWjATMREwDwYDVQQDEwhzd2FybS1jYTBZMBMGByqGSM49AgEGCCqGSM49AwEH\nA0IABJk/VyMPYdaqDXJb/VXh5n/1Yuv7iNrxV3Qb3l06XD46seovcDWs3IZNV1lf\n3Skyr0ofcchipoiHkXBODojJydSjQjBAMA4GA1UdDwEB/wQEAwIBBjAPBgNVHRMB\nAf8EBTADAQH/MB0GA1UdDgQWBBRUXxuRcnFjDfR/RIAUQab8ZV/n4jAKBggqhkjO\nPQQDAgNIADBFAiAy+JTe6Uc3KyLCMiqGl2GyWGQqQDEcO3/YG36x7om65AIhAJvz\npxv6zFeVEkAEEkqIYi0omA9+CjanB/6Bz4n1uw8H\n-----END CERTIFICATE-----\n",
        "CertIssuerSubject": "MBMxETAPBgNVBAMTCHN3YXJtLWNh",
        "CertIssuerPublicKey": "MFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEmT9XIw9h1qoNclv9VeHmf/Vi6/uI2vFXdBveXTpcPjqx6i9wNazchk1XWV/dKTKvSh9xyGKmiIeRcE4OiMnJ1A=="
      },
      "DataPathPort": 4789,
      "SubnetSize": 24
    }
  },
  "InitBinary": "docker-init",
  "ContainerdCommit": {
    "ID": "cfb82a876ecc11b5ca0977d1733adbe58599088a",
    "Expected": "2d41c047c83e09a6d61d464906feb2a2f3c52aa4"
  },
  "RuncCommit": {
    "ID": "cfb82a876ecc11b5ca0977d1733adbe58599088a",
    "Expected": "2d41c047c83e09a6d61d464906feb2a2f3c52aa4"
  },
  "InitCommit": {
    "ID": "cfb82a876ecc11b5ca0977d1733adbe58599088a",
    "Expected": "2d41c047c83e09a6d61d464906feb2a2f3c52aa4"
  },
  "SecurityOptions": [
    "name=apparmor",
    "name=seccomp,profile=default",
    "name=selinux",
    "name=userns",
    "name=rootless"
  ],
  "ProductLicense": "Community Engine",
  "DefaultAddressPools": [
    {
      "Base": "10.10.0.0/16"
    }
  ],
  "Warnings": [
    "WARNING: No memory limit support",
    "WARNING: bridge-nf-call-iptables is disabled",
    "WARNING: bridge-nf-call-ip6tables is disabled"
  ],
  "CDISpecDirs": [
    "/etc/cdi",
    "/var/run/cdi"
  ],
  "Containerd": {
    "Address": "/run/containerd/containerd.sock",
    "Namespaces": {
      "Containers": "moby",
      "Plugins": "plugins.moby"
    }
  }
}