Docker Engine API
  1. Schemas
Docker Engine API
  • System
    • Ping
    • Check auth configuration
    • Monitor events
    • Get system information
    • Get data usage information
    • Get version
  • Image
    • Build an image
    • Delete builder cache
    • Create a new image from a container
    • Create an image
    • Export several images
    • List Images
    • Import images
    • Delete unused images
    • Search images
    • Remove an image
    • Export an image
    • Get the history of an image
    • Inspect an image
    • Push an image
    • Tag an image
  • Config
    • List configs
    • Create a config
    • Delete a config
    • Inspect a config
    • Update a Config
  • Container
    • Create a container
    • List containers
    • Delete stopped containers
    • Remove a container
    • Get an archive of a filesystem resource in a container
    • Get information about files in a container
    • Extract an archive of files or folders to a directory in a container
    • Attach to a container
    • Attach to a container via a websocket
    • Get changes on a container’s filesystem
    • Export a container
    • Inspect a container
    • Kill a container
    • Get container logs
    • Pause a container
    • Rename a container
    • Resize a container TTY
    • Restart a container
    • Start a container
    • Get container stats based on resource usage
    • Stop a container
    • List processes running inside a container
    • Unpause a container
    • Update a container
    • Wait for a container
  • Exec
    • Create an exec instance
    • Inspect an exec instance
    • Resize an exec instance
    • Start an exec instance
  • Distribution
    • Get image information from the registry
  • Network
    • List networks
    • Create a network
    • Delete unused networks
    • Remove a network
    • Inspect a network
    • Connect a container to a network
    • Disconnect a container from a network
  • Node
    • List nodes
    • Delete a node
    • Inspect a node
    • Update a node
  • Plugin
    • List plugins
    • Create a plugin
    • Get plugin privileges
    • Install a plugin
    • Remove a plugin
    • Disable a plugin
    • Enable a plugin
    • Inspect a plugin
    • Push a plugin
    • Configure a plugin
    • Upgrade a plugin
  • Secret
    • List secrets
    • Create a secret
    • Delete a secret
    • Inspect a secret
    • Update a Secret
  • Service
    • List services
    • Create a service
    • Delete a service
    • Inspect a service
    • Get service logs
    • Update a service
  • Session (experimental)
    • Initialize interactive session
  • Swarm
    • Inspect swarm
    • Initialize a new swarm
    • Join an existing swarm
    • Leave a swarm
    • Unlock a locked manager
    • Get the unlock key
    • Update a swarm
  • Task
    • List tasks
    • Inspect a task
  • Volume
    • List volumes
    • Create a volume
    • Delete unused volumes
    • Remove a volume
    • Inspect a volume
  • Get task logs
    GET
  • Schemas
    • Schemas
      • Address
      • AuthConfig
      • BuildInfo
      • ClusterInfo
      • Commit
      • Config
      • ConfigSpec
      • ContainerConfig
      • ContainerSummary
      • CreateImageInfo
      • DeviceMapping
      • Driver
      • EndpointIPAMConfig
      • EndpointPortConfig
      • EndpointSettings
      • EndpointSpec
      • EngineDescription
      • ErrorDetail
      • ErrorResponse
      • GenericResources
      • GraphDriverData
      • HealthConfig
      • HostConfig
      • IPAM
      • IdResponse
      • Image
      • ImageDeleteResponseItem
      • ImageSummary
      • IndexInfo
      • JoinTokens
      • LocalNodeState
      • ManagerStatus
      • Mount
      • MountPoint
      • Network
      • NetworkContainer
      • NetworkSettings
      • Node
      • NodeDescription
      • NodeSpec
      • NodeState
      • NodeStatus
      • ObjectVersion
      • PeerNode
      • Platform
      • Plugin
      • PluginDevice
      • PluginEnv
      • PluginInterfaceType
      • PluginMount
      • PluginsInfo
      • Port
      • PortBinding
      • PortMap
      • ProcessConfig
      • ProgressDetail
      • PushImageInfo
      • Reachability
      • RegistryServiceConfig
      • ResourceObject
      • Resources
      • RestartPolicy
      • Runtime
      • Secret
      • SecretSpec
      • Service
      • ServiceSpec
      • ServiceUpdateResponse
      • Swarm
      • SwarmInfo
      • SwarmSpec
      • SystemInfo
      • TLSInfo
      • Task
      • TaskSpec
      • TaskState
      • ThrottleDevice
      • Volume
    • RequestBodies
      • PluginPullBody
  1. Schemas

SwarmInfo

Represents generic information about swarm.

{
    "Cluster": {
        "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
        }
    },
    "ControlAvailable": true,
    "Error": "",
    "LocalNodeState": "active",
    "Managers": 3,
    "NodeAddr": "10.0.0.46",
    "NodeID": "k67qz4598weg5unwwffg6z1m1",
    "Nodes": 4,
    "RemoteManagers": [
        {
            "Addr": "10.0.0.158:2377",
            "NodeID": "71izy0goik036k48jg985xnds"
        },
        {
            "Addr": "10.0.0.159:2377",
            "NodeID": "79y6h1o4gv8n120drcprv5nmc"
        },
        {
            "Addr": "10.0.0.46:2377",
            "NodeID": "k67qz4598weg5unwwffg6z1m1"
        }
    ]
}
Built with