---
title: "GET /nodes"
method: GET
path: "/nodes"
---

# GET /nodes

`GET /nodes`

List nodes

## Query parameters

- `filters` string

## Response `200`

The request has succeeded.

- Node[]
  - `ID` string
  - `Version` ObjectVersion — 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
  - `CreatedAt` string, date-time — Date and time at which the node was added to the swarm in [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format with nano-seconds.
  - `UpdatedAt` string, date-time — Date and time at which the node was last updated in [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format with nano-seconds.
  - `Spec` NodeSpec
    - `Name` string — Name for the node.
    - `Labels` object — User-defined key/value metadata.
    - `Role` 'worker' | 'manager' — Role of the node.
    - `Availability` 'active' | 'pause' | 'drain' — Availability of the node.
  - `Description` NodeDescription — NodeDescription encapsulates the properties of the Node as reported by the agent.
    - `Hostname` string
    - `Platform` Platform — Platform represents the platform (Arch/OS).
      - `Architecture` string — Architecture represents the hardware architecture (for example, `x86_64`).
      - `OS` string — OS represents the Operating System (for example, `linux` or `windows`).
    - `Resources` ResourceObject — An object describing the resources which can be advertised by a node and requested by a task.
      - `NanoCPUs` integer
      - `MemoryBytes` integer
      - `GenericResources` object[]
        - `NamedResourceSpec` object
          - `Kind` string
          - `Value` string
        - `DiscreteResourceSpec` object
          - `Kind` string
          - `Value` integer
    - `Engine` EngineDescription — EngineDescription provides information about an engine.
      - `EngineVersion` string
      - `Labels` object
      - `Plugins` object[]
        - `Type` string
        - `Name` string
    - `TLSInfo` TLSInfo — Information about the issuer of leaf TLS certificates and the trusted root CA certificate.
      - `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.
  - `Status` NodeStatus — NodeStatus represents the status of a node. It provides the current status of the node, as seen by the manager.
    - `State` 'unknown' | 'down' | 'ready' | 'disconnected' — NodeState represents the state of a node.
    - `Message` string
    - `Addr` string — IP address of the node.
  - `ManagerStatus` ManagerStatus — ManagerStatus represents the status of a manager. It provides the current status of a node's manager component, if the node is a manager.
    - `Leader` boolean
    - `Reachability` 'unknown' | 'unreachable' | 'reachable' — Reachability represents the reachability of a node.
    - `Addr` string — The IP address and port at which the manager is reachable.

---

[API](https://skmtc.net/hexlet/apis/docker-engine-api.md) · [All operations](https://skmtc.net/hexlet/apis/docker-engine-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/hexlet/docker-engine-api/versions/7dbd508c79cf/schema)
