--- title: "Inspect swarm" method: GET path: "/swarm" tags: ["Swarm"] --- # Inspect swarm `GET /swarm` ## Response `200` no error - Swarm, nullable — ClusterInfo represents information about the swarm as is returned by the "/info" endpoint. Join-tokens are not included. - `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, dateTime — 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, dateTime — 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 — The number of historic tasks to keep per instance or node. If negative, never remove completed or failed tasks. - `Raft` object — Raft configuration. - `SnapshotInterval` integer — The number of log entries between snapshots. - `KeepOldSnapshots` integer — The number of snapshots to keep beyond the current snapshot. - `LogEntriesForSlowFollowers` integer — The number of log entries to keep around to sync up slow followers after a snapshot is created. - `ElectionTick` integer — The number of ticks that a follower will wait for a message from the leader before becoming a candidate and starting an election. `ElectionTick` must be greater than `HeartbeatTick`. A tick currently defaults to one second, so these translate directly to seconds currently, but this is NOT guaranteed. - `HeartbeatTick` integer — The number of ticks between heartbeats. Every HeartbeatTick ticks, the leader will send a heartbeat to the followers. A tick currently defaults to one second, so these translate directly to seconds currently, but this is NOT guaranteed. - `Dispatcher` object, nullable — Dispatcher configuration. - `HeartbeatPeriod` integer — The delay for an agent to send a heartbeat to the dispatcher. - `CAConfig` object, nullable — CA configuration. - `NodeCertExpiry` integer — The duration node certificates are issued for. - `ExternalCAs` object[] — Configuration for forwarding signing requests to an external certificate authority. - `Protocol` 'cfssl' — Protocol for communication with the external CA (currently only `cfssl` is supported). - `URL` string — URL where certificate signing requests should be sent. - `Options` object — An object with key/value pairs that are interpreted as protocol-specific options for the external CA driver. - `CACert` string — The root CA certificate (in PEM format) this external CA uses to issue TLS certificates (assumed to be to the current swarm root CA certificate if not provided). - `SigningCACert` string — The desired signing CA certificate for all swarm node TLS leaf certificates, in PEM format. - `SigningCAKey` string — The desired signing CA key for all swarm node TLS leaf certificates, in PEM format. - `ForceRotate` integer — An integer whose purpose is to force swarm to generate a new signing CA certificate and key, if none have been specified in `SigningCACert` and `SigningCAKey` - `EncryptionConfig` object — Parameters related to encryption-at-rest. - `AutoLockManagers` boolean — If set, generate a key and use it to lock data stored on the managers. - `TaskDefaults` object — Defaults for creating tasks in this cluster. - `LogDriver` object — The log driver to use for tasks created in the orchestrator if unspecified by a service. Updating this value only affects new tasks. Existing tasks continue to use their previously configured log driver until recreated. - `Name` string — The log driver to use as a default for new tasks. - `Options` object — Driver-specific options for the selected log driver, specified as key/value pairs. - `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. ## Other responses - `404` — no such swarm - `500` — server error - `503` — node is not part of a swarm --- [API](https://skmtc.net/moby/apis/docker-engine-api.md) · [All operations](https://skmtc.net/moby/apis/docker-engine-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/moby/docker-engine-api/versions/4752769870da/schema)