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

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 se

{
    "Index": 373531
}
Built with