List nodes

/v1.33

GET

/nodes

Node

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

filters

string

optional

Filters to process on the nodes list, encoded as JSON (a map[string][]string).

Available filters:

id=<node id>

label=<engine label>

membership=(accepted|pending)`

name=<node name>

role=(manager|worker)`

Responses

🟢200no error

application/json

Body

array of:

CreatedAt

string <dateTime>

optional

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

Example:

2016-08-18T10:44:24.496525531Z

Description

object (NodeDescription)

optional

NodeDescription encapsulates the properties of the Node as reported by the
agent.

Engine

object (EngineDescription)

optional

EngineDescription provides information about an engine.

Hostname

string

optional

Example:

bf3067039e47

Platform

object (Platform)

optional

Platform represents the platform (Arch/OS).

Resources

object (ResourceObject)

optional

An object describing the resources which can be advertised by a node and requested by a task

TLSInfo

object (TLSInfo)

optional

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

Example:

{"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"}

string

optional

Example:

24ifsmvkjbyhk

ManagerStatus

object (ManagerStatus) | null

optional

ManagerStatus represents the status of a manager.

It provides the current status of a node's manager component, if the node
is a manager.

Addr

string

optional

The IP address and port at which the manager is reachable.

Example:

10.0.0.46:2377

Leader

boolean

optional

Default:

false

Example:

true

Reachability

enum<string>

optional

Reachability represents the reachability of a node.

Allowed values:

unknownunreachablereachable

Example:

reachable

Spec

object (NodeSpec)

optional

Example:

{"Availability":"active","Labels":{"foo":"bar"},"Name":"node-name","Role":"manager"}

Availability

enum<string>

optional

Availability of the node.

Allowed values:

activepausedrain

Example:

active

Labels

object

optional

User-defined key/value metadata.

Name

string

optional

Name for the node.

Example:

my-node

Role

enum<string>

optional

Role of the node.

Allowed values:

workermanager

Example:

manager

Status

object (NodeStatus)

optional

NodeStatus represents the status of a node.

It provides the current status of the node, as seen by the manager.

Addr

string

optional

IP address of the node.

Example:

172.17.0.2

Message

string

optional

Example:

State

enum<string>

optional

NodeState represents the state of a node.

Allowed values:

unknowndownreadydisconnected

Example:

ready

UpdatedAt

string <dateTime>

optional

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

Example:

2017-08-09T07:09:37.632105588Z

Version

object (ObjectVersion)

optional

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.

Index

integer <uint64>

optional

Example:

373531

🔴500server error

🔴503node is not part of a swarm

Modified at 2022-09-10 17:56:06

Disconnect a container from a network

Delete a node