Docker Engine API
  1. Node
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
      GET
    • Delete a node
      DELETE
    • Inspect a node
      GET
    • Update a node
      POST
  • 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. Node

List nodes

/v1.33
/v1.33
/v1.33
/v1.33
GET
/nodes
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET '/v1.33/nodes'
Response Response Example
200 - Example 1
[
    {
        "CreatedAt": "2016-08-18T10:44:24.496525531Z",
        "Description": {
            "Engine": {
                "EngineVersion": "17.06.0",
                "Labels": {
                    "foo": "bar"
                },
                "Plugins": [
                    {
                        "Name": "awslogs",
                        "Type": "Log"
                    },
                    {
                        "Name": "fluentd",
                        "Type": "Log"
                    },
                    {
                        "Name": "gcplogs",
                        "Type": "Log"
                    },
                    {
                        "Name": "gelf",
                        "Type": "Log"
                    },
                    {
                        "Name": "journald",
                        "Type": "Log"
                    },
                    {
                        "Name": "json-file",
                        "Type": "Log"
                    },
                    {
                        "Name": "logentries",
                        "Type": "Log"
                    },
                    {
                        "Name": "splunk",
                        "Type": "Log"
                    },
                    {
                        "Name": "syslog",
                        "Type": "Log"
                    },
                    {
                        "Name": "bridge",
                        "Type": "Network"
                    },
                    {
                        "Name": "host",
                        "Type": "Network"
                    },
                    {
                        "Name": "ipvlan",
                        "Type": "Network"
                    },
                    {
                        "Name": "macvlan",
                        "Type": "Network"
                    },
                    {
                        "Name": "null",
                        "Type": "Network"
                    },
                    {
                        "Name": "overlay",
                        "Type": "Network"
                    },
                    {
                        "Name": "local",
                        "Type": "Volume"
                    },
                    {
                        "Name": "localhost:5000/vieux/sshfs:latest",
                        "Type": "Volume"
                    },
                    {
                        "Name": "vieux/sshfs:latest",
                        "Type": "Volume"
                    }
                ]
            },
            "Hostname": "bf3067039e47",
            "Platform": {
                "Architecture": "x86_64",
                "OS": "linux"
            },
            "Resources": {
                "GenericResources": [
                    {
                        "DiscreteResourceSpec": {
                            "Kind": "SSD",
                            "Value": 3
                        }
                    },
                    {
                        "NamedResourceSpec": {
                            "Kind": "GPU",
                            "Value": "UUID1"
                        }
                    },
                    {
                        "NamedResourceSpec": {
                            "Kind": "GPU",
                            "Value": "UUID2"
                        }
                    }
                ],
                "MemoryBytes": 8272408576,
                "NanoCPUs": 4000000000
            },
            "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"
            }
        },
        "ID": "24ifsmvkjbyhk",
        "ManagerStatus": {
            "Addr": "10.0.0.46:2377",
            "Leader": true,
            "Reachability": "reachable"
        },
        "Spec": {
            "Availability": "active",
            "Labels": {
                "foo": "bar"
            },
            "Name": "node-name",
            "Role": "manager"
        },
        "Status": {
            "Addr": "172.17.0.2",
            "Message": "",
            "State": "ready"
        },
        "UpdatedAt": "2017-08-09T07:09:37.632105588Z",
        "Version": {
            "Index": 373531
        }
    }
]

Request

Query Params

Responses

🟢200no error
application/json
Body

🔴500server error
🔴503node is not part of a swarm
Modified at 2022-09-10 17:56:06
Previous
Disconnect a container from a network
Next
Delete a node
Built with