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

Task

{
    "AssignedGenericResources": [
        {
            "DiscreteResourceSpec": {
                "Kind": "SSD",
                "Value": 3
            }
        },
        {
            "NamedResourceSpec": {
                "Kind": "GPU",
                "Value": "UUID1"
            }
        },
        {
            "NamedResourceSpec": {
                "Kind": "GPU",
                "Value": "UUID2"
            }
        }
    ],
    "CreatedAt": "2016-06-07T21:07:31.171892745Z",
    "DesiredState": "running",
    "ID": "0kzzo1i0y4jz6027t0k7aezc7",
    "NetworksAttachments": [
        {
            "Addresses": [
                "10.255.0.10/16"
            ],
            "Network": {
                "CreatedAt": "2016-06-07T20:31:11.912919752Z",
                "DriverState": {
                    "Name": "overlay",
                    "Options": {
                        "com.docker.network.driver.overlay.vxlanid_list": "256"
                    }
                },
                "ID": "4qvuz4ko70xaltuqbt8956gd1",
                "IPAMOptions": {
                    "Configs": [
                        {
                            "Gateway": "10.255.0.1",
                            "Subnet": "10.255.0.0/16"
                        }
                    ],
                    "Driver": {
                        "Name": "default"
                    }
                },
                "Spec": {
                    "DriverConfiguration": {},
                    "IPAMOptions": {
                        "Configs": [
                            {
                                "Gateway": "10.255.0.1",
                                "Subnet": "10.255.0.0/16"
                            }
                        ],
                        "Driver": {}
                    },
                    "Labels": {
                        "com.docker.swarm.internal": "true"
                    },
                    "Name": "ingress"
                },
                "UpdatedAt": "2016-06-07T21:07:29.955277358Z",
                "Version": {
                    "Index": 18
                }
            }
        }
    ],
    "NodeID": "60gvrl6tm78dmak4yl7srz94v",
    "ServiceID": "9mnpnzenvg8p8tdbtq4wvbkcz",
    "Slot": 1,
    "Spec": {
        "ContainerSpec": {
            "Image": "redis"
        },
        "Placement": {},
        "Resources": {
            "Limits": {},
            "Reservations": {}
        },
        "RestartPolicy": {
            "Condition": "any",
            "MaxAttempts": 0
        }
    },
    "Status": {
        "ContainerStatus": {
            "ContainerID": "e5d62702a1b48d01c3e02ca1e0212a250801fa8d67caca0b6f35919ebc12f035",
            "PID": 677
        },
        "Message": "started",
        "State": "running",
        "Timestamp": "2016-06-07T21:07:31.290032978Z"
    },
    "UpdatedAt": "2016-06-07T21:07:31.376370513Z",
    "Version": {
        "Index": 71
    }
}
Built with