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

Get system information

/v1.33
/v1.33
/v1.33
/v1.33
GET
/info
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET '/v1.33/info'
Response Response Example
200 - Example 1
{
    "Architecture": "x86_64",
    "BridgeNfIp6tables": true,
    "BridgeNfIptables": true,
    "CPUSet": true,
    "CPUShares": true,
    "CgroupDriver": "cgroupfs",
    "ClusterAdvertise": "node5.corp.example.com:8000",
    "ClusterStore": "consul://consul.corp.example.com:8600/some/path",
    "ContainerdCommit": {
        "Expected": "2d41c047c83e09a6d61d464906feb2a2f3c52aa4",
        "ID": "cfb82a876ecc11b5ca0977d1733adbe58599088a"
    },
    "Containers": 14,
    "ContainersPaused": 1,
    "ContainersRunning": 3,
    "ContainersStopped": 10,
    "CpuCfsPeriod": true,
    "CpuCfsQuota": true,
    "Debug": true,
    "DefaultRuntime": "runc",
    "DockerRootDir": "/var/lib/docker",
    "Driver": "overlay2",
    "DriverStatus": [
        [
            "Backing Filesystem",
            "extfs"
        ],
        [
            "Supports d_type",
            "true"
        ],
        [
            "Native Overlay Diff",
            "true"
        ]
    ],
    "ExperimentalBuild": true,
    "GenericResources": [
        {
            "DiscreteResourceSpec": {
                "Kind": "SSD",
                "Value": 3
            }
        },
        {
            "NamedResourceSpec": {
                "Kind": "GPU",
                "Value": "UUID1"
            }
        },
        {
            "NamedResourceSpec": {
                "Kind": "GPU",
                "Value": "UUID2"
            }
        }
    ],
    "HttpProxy": "http://user:pass@proxy.corp.example.com:8080",
    "HttpsProxy": "https://user:pass@proxy.corp.example.com:4443",
    "ID": "7TRN:IPZB:QYBB:VPBQ:UMPP:KARE:6ZNR:XE6T:7EWV:PKF4:ZOJD:TPYS",
    "IPv4Forwarding": true,
    "Images": 508,
    "IndexServerAddress": "https://index.docker.io/v1/",
    "InitBinary": "docker-init",
    "InitCommit": {
        "Expected": "2d41c047c83e09a6d61d464906feb2a2f3c52aa4",
        "ID": "cfb82a876ecc11b5ca0977d1733adbe58599088a"
    },
    "Isolation": "default",
    "KernelMemory": true,
    "KernelVersion": "4.9.38-moby",
    "Labels": [
        "storage=ssd",
        "production"
    ],
    "LiveRestoreEnabled": false,
    "LoggingDriver": "string",
    "MemTotal": 2095882240,
    "MemoryLimit": true,
    "NCPU": 4,
    "NEventsListener": 30,
    "NFd": 64,
    "NGoroutines": 174,
    "Name": "node5.corp.example.com",
    "NoProxy": "*.local, 169.254/16",
    "OSType": "linux",
    "OomKillDisable": true,
    "OperatingSystem": "Alpine Linux v3.5",
    "Plugins": {
        "Authorization": [
            "img-authz-plugin",
            "hbm"
        ],
        "Log": [
            "awslogs",
            "fluentd",
            "gcplogs",
            "gelf",
            "journald",
            "json-file",
            "logentries",
            "splunk",
            "syslog"
        ],
        "Network": [
            "bridge",
            "host",
            "ipvlan",
            "macvlan",
            "null",
            "overlay"
        ],
        "Volume": [
            "local"
        ]
    },
    "RegistryConfig": {
        "AllowNondistributableArtifactsCIDRs": [
            "::1/128",
            "127.0.0.0/8"
        ],
        "AllowNondistributableArtifactsHostnames": [
            "registry.internal.corp.example.com:3000",
            "[2001:db8:a0b:12f0::1]:443"
        ],
        "IndexConfigs": {
            "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": [
            "::1/128",
            "127.0.0.0/8"
        ],
        "Mirrors": [
            "https://hub-mirror.corp.example.com:5000/",
            "https://[2001:db8:a0b:12f0::1]/"
        ]
    },
    "RuncCommit": {
        "Expected": "2d41c047c83e09a6d61d464906feb2a2f3c52aa4",
        "ID": "cfb82a876ecc11b5ca0977d1733adbe58599088a"
    },
    "Runtimes": {
        "custom": {
            "path": "/usr/local/bin/my-oci-runtime",
            "runtimeArgs": [
                "--debug",
                "--systemd-cgroup=false"
            ]
        },
        "runc": {
            "path": "docker-runc"
        },
        "runc-master": {
            "path": "/go/bin/runc"
        }
    },
    "SecurityOptions": [
        "name=apparmor",
        "name=seccomp,profile=default",
        "name=selinux",
        "name=userns"
    ],
    "ServerVersion": "17.06.0-ce",
    "SwapLimit": true,
    "Swarm": {
        "Cluster": {
            "CreatedAt": "2016-08-18T10:44:24.496525531Z",
            "ID": "abajmipo7b4xz5ip2nrla6b11",
            "RootRotationInProgress": false,
            "Spec": {
                "CAConfig": {
                    "ExternalCAs": [
                        {
                            "CACert": "string",
                            "Options": {
                                "property1": "string",
                                "property2": "string"
                            },
                            "Protocol": "cfssl",
                            "URL": "string"
                        }
                    ],
                    "ForceRotate": 0,
                    "NodeCertExpiry": 7776000000000000,
                    "SigningCACert": "string",
                    "SigningCAKey": "string"
                },
                "Dispatcher": {
                    "HeartbeatPeriod": 5000000000
                },
                "EncryptionConfig": {
                    "AutoLockManagers": false
                },
                "Labels": {
                    "com.example.corp.department": "engineering",
                    "com.example.corp.type": "production"
                },
                "Name": "default",
                "Orchestration": {
                    "TaskHistoryRetentionLimit": 10
                },
                "Raft": {
                    "ElectionTick": 3,
                    "HeartbeatTick": 1,
                    "KeepOldSnapshots": 0,
                    "LogEntriesForSlowFollowers": 500,
                    "SnapshotInterval": 10000
                },
                "TaskDefaults": {
                    "LogDriver": {
                        "Name": "json-file",
                        "Options": {
                            "max-file": "10",
                            "max-size": "100m"
                        }
                    }
                }
            },
            "TLSInfo": {
                "CertIssuerPublicKey": "MFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEmT9XIw9h1qoNclv9VeHmf/Vi6/uI2vFXdBveXTpcPjqx6i9wNazchk1XWV/dKTKvSh9xyGKmiIeRcE4OiMnJ1A==",
                "CertIssuerSubject": "MBMxETAPBgNVBAMTCHN3YXJtLWNh",
                "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"
            },
            "UpdatedAt": "2017-08-09T07:09:37.632105588Z",
            "Version": {
                "Index": 373531
            }
        },
        "ControlAvailable": true,
        "Error": "",
        "LocalNodeState": "active",
        "Managers": 3,
        "NodeAddr": "10.0.0.46",
        "NodeID": "k67qz4598weg5unwwffg6z1m1",
        "Nodes": 4,
        "RemoteManagers": [
            {
                "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": [
        [
            "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"
        ]
    ],
    "SystemTime": "2017-08-08T20:28:29.06202363Z"
}

Request

None

Responses

🟢200No error
application/json
Body

🔴500Server error
Modified at 2022-09-10 17:56:06
Previous
Monitor events
Next
Get data usage information
Built with