Inspect swarm

{ "CreatedAt": "2016-08-18T10:44:24.496525531Z", "ID": "abajmipo7b4xz5ip2nrla6b11", "RootRotationInProgress": false, "Spec": { "CAConfig": { "ExternalCAs": [ { "CACert": "string", "Options": { "property1": "string", "property2": "string" }, "Protocol": "cfssl", "URL": "string" } ], "ForceRotate": 0, "NodeCertExpiry": 7776000000000000, "SigningCACert": "string", "SigningCAKey": "string" }, "Dispatcher": { "HeartbeatPeriod": 5000000000 }, "EncryptionConfig": { "AutoLockManagers": false }, "Labels": { "com.example.corp.department": "engineering", "com.example.corp.type": "production" }, "Name": "default", "Orchestration": { "TaskHistoryRetentionLimit": 10 }, "Raft": { "ElectionTick": 3, "HeartbeatTick": 1, "KeepOldSnapshots": 0, "LogEntriesForSlowFollowers": 500, "SnapshotInterval": 10000 }, "TaskDefaults": { "LogDriver": { "Name": "json-file", "Options": { "max-file": "10", "max-size": "100m" } } } }, "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" }, "UpdatedAt": "2017-08-09T07:09:37.632105588Z", "Version": { "Index": 373531 }, "JoinTokens": { "Manager": "SWMTKN-1-3pu6hszjas19xyp7ghgosyx9k8atbfcr8p2is99znpy26u2lkl-7p73s1dx5in4tatdymyhg9hu2", "Worker": "SWMTKN-1-3pu6hszjas19xyp7ghgosyx9k8atbfcr8p2is99znpy26u2lkl-1awxwuwd3z9j1z3puu7rcgdbx" } }

Responses

🟢200no error

application/json

Body

ClusterInfo represents information about the swarm as is returned by the "/info" endpoint. Join-tokens are not included.

CreatedAt

string <dateTime>

optional

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

Example:

2016-08-18T10:44:24.496525531Z

string

optional

The ID of the swarm.

Example:

abajmipo7b4xz5ip2nrla6b11

RootRotationInProgress

boolean

optional

Whether there is currently a root CA rotation in progress for the swarm

Example:

false

Spec

object

SwarmSpec

optional

User modifiable swarm configuration.

CAConfig

object | null

optional

CA configuration.

Dispatcher

object | null

optional

Dispatcher configuration.

EncryptionConfig

object

optional

Parameters related to encryption-at-rest.

Labels

object

optional

User-defined key/value metadata.

Example:

{"com.example.corp.department":"engineering","com.example.corp.type":"production"}

Name

string

optional

Name of the swarm.

Example:

default

Orchestration

object | null

optional

Orchestration configuration.

Raft

object

optional

Raft configuration.

TaskDefaults

object

optional

Defaults for creating tasks in this cluster.

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

CertIssuerPublicKey

string

optional

The base64-url-safe-encoded raw public key bytes of the issuer

CertIssuerSubject

string

optional

The base64-url-safe-encoded raw subject bytes of the issuer

TrustRoot

string

optional

The root CA certificate(s) that are used to validate leaf TLS certificates

UpdatedAt

string <dateTime>

optional

Date and time at which the swarm 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

JoinTokens

object

JoinTokens

optional

JoinTokens contains the tokens workers and managers need to join the swarm.

Manager

string

optional

The token managers can use to join the swarm.

Example:

SWMTKN-1-3pu6hszjas19xyp7ghgosyx9k8atbfcr8p2is99znpy26u2lkl-7p73s1dx5in4tatdymyhg9hu2

Worker

string

optional

The token workers can use to join the swarm.

Example:

SWMTKN-1-3pu6hszjas19xyp7ghgosyx9k8atbfcr8p2is99znpy26u2lkl-1awxwuwd3z9j1z3puu7rcgdbx

🟠404no such swarm

🔴500server error

🔴503node is not part of a swarm

Request

Responses