Responses

• 200 application/json

  No error

  Hide response attributes Show response attributes object

  • ID 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.

  • Containers integer

    Total number of containers on the host.

  • ContainersRunning integer

    Number of containers with status "running".

  • ContainersPaused integer

    Number of containers with status "paused".

  • ContainersStopped integer

    Number of containers with status "stopped".

  • Images integer

    Total number of images on the host.

    Both tagged and untagged (dangling) images are counted.

  • Driver string

    Name of the storage driver in use.

  • DriverStatus array[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.
  • DockerRootDir string

    Root directory of persistent Docker state.

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

  • Plugins object

    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.

    Hide Plugins attributes Show Plugins attributes object

    • Volume array[string]

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

    • Network array[string]

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

    • Authorization array[string]

      Names of available authorization plugins.

    • Log array[string]

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

  • MemoryLimit boolean

    Indicates if the host has memory limit support enabled.

  • SwapLimit boolean

    Indicates if the host has memory swap limit support enabled.

  • KernelMemoryTCP boolean

    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.

  • CpuCfsPeriod boolean

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

  • CpuCfsQuota boolean

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

  • CPUShares boolean

    Indicates if CPU Shares limiting is supported by the host.

  • CPUSet boolean

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

    See cpuset(7)

  • PidsLimit boolean

    Indicates if the host kernel has PID limit support enabled.

  • OomKillDisable boolean

    Indicates if OOM killer disable is supported on the host.

  • IPv4Forwarding boolean

    Indicates IPv4 forwarding is enabled.

  • BridgeNfIptables boolean

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

  • BridgeNfIp6tables boolean

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

  • Debug boolean

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

  • NFd integer

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

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

  • NGoroutines integer

    The number of goroutines that currently exist.

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

  • SystemTime string

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

  • LoggingDriver string

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

  • CgroupDriver string

    The driver to use for managing cgroups.

    Values are cgroupfs, systemd, or none. Default value is cgroupfs.

  • CgroupVersion string

    The version of the cgroup.

    Values are 1 or 2. Default value is 1.

  • NEventsListener integer

    Number of event listeners subscribed.

  • KernelVersion 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)".

  • OperatingSystem string

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

  • OSVersion 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.

  • OSType 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.

  • Architecture string

    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.

  • NCPU 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.

  • MemTotal integer(int64)

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

  • IndexServerAddress string

    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 value is https://index.docker.io/v1/.

  • RegistryConfig object

    RegistryServiceConfig stores daemon registry services configuration.

    Hide RegistryConfig attributes Show RegistryConfig attributes object

    • AllowNondistributableArtifactsCIDRs array[string]

      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.

    • AllowNondistributableArtifactsHostnames array[string]

      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.

      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.

    • InsecureRegistryCIDRs array[string]

      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.

    • IndexConfigs object
      Hide IndexConfigs attribute Show IndexConfigs attribute object

      • * object Additional properties

        IndexInfo contains information about a registry.

        Hide * attributes Show * attributes object

        • Name string

          Name of the registry, such as "docker.io".

        • Mirrors array[string]

          List of mirrors, expressed as URIs.

        • Secure boolean

          Indicates if the registry is part of the list of insecure registries.

          If false, the registry is insecure. Insecure registries accept un-encrypted (HTTP) and/or untrusted (HTTPS with certificates from unknown CAs) communication.

          Warning: Insecure registries can be useful when running a local registry. However, because its use creates security vulnerabilities it should ONLY be enabled for testing purposes. For increased security, users should add their CA to their system's list of trusted CAs instead of enabling this option.

        • Official boolean

          Indicates whether this is an official registry (i.e., Docker Hub / docker.io)

    • Mirrors array[string]

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

  • GenericResources array[object]

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

    Hide GenericResources attributes Show GenericResources attributes object

    • NamedResourceSpec object
      Hide NamedResourceSpec attributes Show NamedResourceSpec attributes object

      • Kind string
      • Value string
    • DiscreteResourceSpec object
      Hide DiscreteResourceSpec attributes Show DiscreteResourceSpec attributes object

      • Kind string
      • Value integer(int64)
  • HttpProxy 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.

  • HttpsProxy 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.

  • NoProxy 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.

  • Name string

    Hostname of the host.

  • Labels array[string]

    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.

  • ExperimentalBuild boolean

    Indicates if experimental features are enabled on the daemon.

  • ServerVersion string

    Version string of the daemon.

  • Runtimes 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.

    Default value is {"runc"=>{"path"=>"runc"}}.

    Hide Runtimes attribute Show Runtimes attribute object

    • * object Additional properties

      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.

      Hide * attributes Show * attributes object

      • path string

        Name and, optional, path, of the OCI executable binary.

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

      • runtimeArgs array[string]

        List of command-line arguments to pass to the runtime when invoked.

      • status object

        Information specific to the runtime.

        While this API specification does not define data provided by runtimes, the following well-known properties may be provided by runtimes:

        org.opencontainers.runtime-spec.features: features structure as defined in the OCI Runtime Specification, in a JSON string representation.

        
        

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

        Hide status attribute Show status attribute object

        • * string Additional properties
  • DefaultRuntime string

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

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

    Default value is runc.

  • Swarm object

    Represents generic information about swarm.

    Hide Swarm attributes Show Swarm attributes object

    • NodeID string

      Unique identifier of for this node in the swarm.

      Default value is empty.

    • NodeAddr string

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

      Default value is empty.

    • LocalNodeState string

      Current local status of this node.

      Values are , inactive, pending, active, error, or locked. Default value is empty.

    • ControlAvailable boolean

      Default value is false.

    • Error string

      Default value is empty.

    • RemoteManagers array[object]

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

      Represents a peer-node in the swarm

      Hide RemoteManagers attributes Show RemoteManagers attributes object

      • NodeID string

        Unique identifier of for this node in the swarm.

      • Addr string

        IP address and ports at which this node can be reached.

    • Nodes integer

      Total number of nodes in the swarm.

    • Managers integer

      Total number of managers in the swarm.

    • Cluster object

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

      Hide Cluster attributes Show Cluster attributes object

      • ID string

        The ID of the swarm.

      • Version object

        The version number of the object such as node, service, etc. This is needed to avoid conflicting writes. The client must send the version number along with the modified specification when updating these objects.

        This approach ensures safe concurrency and determinism in that the change on the object may not be applied if the version number has changed from the last read. In other words, if two update requests specify the same base version, only one of the requests can succeed. As a result, two separate update requests that happen at the same time will not unintentionally overwrite each other.

        Hide Version attribute Show Version attribute object

        • Index integer(uint64)
      • CreatedAt string(dateTime)

        Date and time at which the swarm was initialised in RFC 3339 format with nano-seconds.

      • UpdatedAt string(dateTime)

        Date and time at which the swarm was last updated in RFC 3339 format with nano-seconds.

      • Spec object

        User modifiable swarm configuration.

        Hide Spec attributes Show Spec attributes object

        • Name string

          Name of the swarm.

        • Labels object

          User-defined key/value metadata.

          Hide Labels attribute Show Labels attribute object

          • * string Additional properties
        • Orchestration object

          Orchestration configuration.

          Hide Orchestration attribute Show Orchestration attribute object

          • TaskHistoryRetentionLimit integer(int64)

            The number of historic tasks to keep per instance or node. If negative, never remove completed or failed tasks.

        • Raft object

          Raft configuration.

          Hide Raft attributes Show Raft attributes object

          • SnapshotInterval integer(uint64)

            The number of log entries between snapshots.

          • KeepOldSnapshots integer(uint64)

            The number of snapshots to keep beyond the current snapshot.

          • LogEntriesForSlowFollowers integer(uint64)

            The number of log entries to keep around to sync up slow followers after a snapshot is created.

          • ElectionTick integer

            The number of ticks that a follower will wait for a message from the leader before becoming a candidate and starting an election. ElectionTick must be greater than HeartbeatTick.

            A tick currently defaults to one second, so these translate directly to seconds currently, but this is NOT guaranteed.

          • HeartbeatTick integer

            The number of ticks between heartbeats. Every HeartbeatTick ticks, the leader will send a heartbeat to the followers.

            A tick currently defaults to one second, so these translate directly to seconds currently, but this is NOT guaranteed.

        • Dispatcher object

          Dispatcher configuration.

          Hide Dispatcher attribute Show Dispatcher attribute object

          • HeartbeatPeriod integer(int64)

            The delay for an agent to send a heartbeat to the dispatcher.

        • CAConfig object

          CA configuration.

          Hide CAConfig attributes Show CAConfig attributes object

          • NodeCertExpiry integer(int64)

            The duration node certificates are issued for.

          • ExternalCAs array[object]

            Configuration for forwarding signing requests to an external certificate authority.

            Hide ExternalCAs attributes Show ExternalCAs attributes object

            • Protocol string

              Protocol for communication with the external CA (currently only cfssl is supported).

              Value is cfssl. Default value is cfssl.

            • URL string

              URL where certificate signing requests should be sent.

            • Options object

              An object with key/value pairs that are interpreted as protocol-specific options for the external CA driver.

              Hide Options attribute Show Options attribute object

              • * string Additional properties
            • CACert string

              The root CA certificate (in PEM format) this external CA uses to issue TLS certificates (assumed to be to the current swarm root CA certificate if not provided).

          • SigningCACert string

            The desired signing CA certificate for all swarm node TLS leaf certificates, in PEM format.

          • SigningCAKey string

            The desired signing CA key for all swarm node TLS leaf certificates, in PEM format.

          • ForceRotate integer(uint64)

            An integer whose purpose is to force swarm to generate a new signing CA certificate and key, if none have been specified in SigningCACert and SigningCAKey

        • EncryptionConfig object

          Parameters related to encryption-at-rest.

          Hide EncryptionConfig attribute Show EncryptionConfig attribute object

          • AutoLockManagers boolean

            If set, generate a key and use it to lock data stored on the managers.

        • TaskDefaults object

          Defaults for creating tasks in this cluster.

          Hide TaskDefaults attribute Show TaskDefaults attribute object

          • LogDriver object

            The log driver to use for tasks created in the orchestrator if unspecified by a service.

            Updating this value only affects new tasks. Existing tasks continue to use their previously configured log driver until recreated.

            Hide LogDriver attributes Show LogDriver attributes object

            • Name string

              The log driver to use as a default for new tasks.

            • Options object

              Driver-specific options for the selectd log driver, specified as key/value pairs.

              Hide Options attribute Show Options attribute object

              • * string Additional properties
      • TLSInfo object

        Information about the issuer of leaf TLS certificates and the trusted root CA certificate.

        Hide TLSInfo attributes Show TLSInfo attributes object

        • TrustRoot string

          The root CA certificate(s) that are used to validate leaf TLS certificates.

        • CertIssuerSubject string

          The base64-url-safe-encoded raw subject bytes of the issuer.

        • CertIssuerPublicKey string

          The base64-url-safe-encoded raw public key bytes of the issuer.

      • RootRotationInProgress boolean

        Whether there is currently a root CA rotation in progress for the swarm

      • DataPathPort integer(uint32)

        DataPathPort specifies the data path port number for data traffic. Acceptable port range is 1024 to 49151. If no port is set or is set to 0, the default port (4789) is used.

        Default value is 4789.

      • DefaultAddrPool array[string(CIDR)]

        Default Address Pool specifies default subnet pools for global scope networks.

      • SubnetSize integer(uint32)

        SubnetSize specifies the subnet size of the networks created from the default subnet pool.

        Maximum value is 29. Default value is 24.

  • LiveRestoreEnabled 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.

    Default value is false.

  • Isolation 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.

    Values are default, hyperv, or process. Default value is default.

  • InitBinary 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.

  • ContainerdCommit object

    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.

    Hide ContainerdCommit attributes Show ContainerdCommit attributes object

    • ID string

      Actual commit ID of external tool.

    • Expected string

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

  • RuncCommit object

    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.

    Hide RuncCommit attributes Show RuncCommit attributes object

    • ID string

      Actual commit ID of external tool.

    • Expected string

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

  • InitCommit object

    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.

    Hide InitCommit attributes Show InitCommit attributes object

    • ID string

      Actual commit ID of external tool.

    • Expected string

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

  • SecurityOptions array[string]

    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.

  • ProductLicense 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.

  • DefaultAddressPools array[object]

    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.

    Hide DefaultAddressPools attributes Show DefaultAddressPools attributes object

    • Base string

      The network address in CIDR format

    • Size integer

      The network pool size

  • Warnings array[string]

    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.

  • CDISpecDirs array[string]

    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.

• 500 application/json

  Server error

  Hide response attribute Show response attribute object

  • message string Required

    The error message.