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

# GET /swarm

`GET /swarm`

Inspect swarm

## Response `200`

The request has succeeded.

- Swarm
  - `ID` string — The ID of the swarm.
  - `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 swarm was initialised in [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format with nano-seconds.
  - `UpdatedAt` string, date-time — Date and time at which the swarm was last updated in [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format with nano-seconds.
  - `Spec` SwarmSpec — User modifiable swarm configuration.
    - `Name` string — Name of the swarm.
    - `Labels` object — User-defined key/value metadata.
    - `Orchestration` object, nullable — Orchestration configuration.
      - `TaskHistoryRetentionLimit` integer
    - `Raft` object — Raft configuration.
      - `SnapshotInterval` integer
      - `KeepOldSnapshots` integer
      - `LogEntriesForSlowFollowers` integer
      - `ElectionTick` integer
      - `HeartbeatTick` integer
    - `Dispatcher` object, nullable — Dispatcher configuration.
      - `HeartbeatPeriod` integer
    - `CAConfig` object, nullable — CA configuration.
      - `NodeCertExpiry` integer
      - `ExternalCAs` object[]
        - `Protocol` 'cfssl'
        - `URL` string
        - `Options` object
        - `CACert` string
      - `SigningCACert` string
      - `SigningCAKey` string
      - `ForceRotate` integer
    - `EncryptionConfig` object — Parameters related to encryption-at-rest.
      - `AutoLockManagers` boolean
    - `TaskDefaults` object — Defaults for creating tasks in this cluster.
      - `LogDriver` object
        - `Name` string
        - `Options` object
  - `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.
  - `RootRotationInProgress` boolean — Whether there is currently a root CA rotation in progress for the swarm
  - `DataPathPort` integer — 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.
  - `DefaultAddrPool` string[] — Default Address Pool specifies default subnet pools for global scope networks.
  - `SubnetSize` integer — SubnetSize specifies the subnet size of the networks created from the default subnet pool.
  - `JoinTokens` JoinTokens — JoinTokens contains the tokens workers and managers need to join the swarm.
    - `Worker` string — The token workers can use to join the swarm.
    - `Manager` string — The token managers can use to join the swarm.

---

[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)