**Warning**: Insecure registries can be useful when running a local\n > registry. However, because its use creates security vulnerabilities\n > it should ONLY be enabled for testing purposes. For increased\n > security, users should add their CA to their system's list of\n > trusted CAs instead of enabling this option.\n type: \"boolean\"\n example: true\n Official:\n description: |\n Indicates whether this is an official registry (i.e., Docker Hub / docker.io)\n type: \"boolean\"\n example: true\n\n Runtime:\n description: |\n Runtime describes an [OCI compliant](https://github.com/opencontainers/runtime-spec)\n runtime.\n\n The runtime is invoked by the daemon via the `containerd` daemon. OCI\n runtimes act as an interface to the Linux kernel namespaces, cgroups,\n and SELinux.\n type: \"object\"\n properties:\n path:\n description: |\n Name and, optional, path, of the OCI executable binary.\n\n If the path is omitted, the daemon searches the host's `$PATH` for the\n binary and uses the first result.\n type: \"string\"\n example: \"/usr/local/bin/my-oci-runtime\"\n runtimeArgs:\n description: |\n List of command-line arguments to pass to the runtime when invoked.\n type: \"array\"\n x-nullable: true\n items:\n type: \"string\"\n example: [\"--debug\", \"--systemd-cgroup=false\"]\n\n Commit:\n description: |\n Commit holds the Git-commit (SHA1) that a binary was built from, as\n reported in the version-string of external tools, such as `containerd`,\n or `runC`.\n type: \"object\"\n properties:\n ID:\n description: \"Actual commit ID of external tool.\"\n type: \"string\"\n example: \"cfb82a876ecc11b5ca0977d1733adbe58599088a\"\n Expected:\n description: |\n Commit ID of external tool expected by dockerd as set at build time.\n type: \"string\"\n example: \"2d41c047c83e09a6d61d464906feb2a2f3c52aa4\"\n\n SwarmInfo:\n description: |\n Represents generic information about swarm.\n type: \"object\"\n properties:\n NodeID:\n description: \"Unique identifier of for this node in the swarm.\"\n type: \"string\"\n default: \"\"\n example: \"k67qz4598weg5unwwffg6z1m1\"\n NodeAddr:\n description: |\n IP address at which this node can be reached by other nodes in the\n swarm.\n type: \"string\"\n default: \"\"\n example: \"10.0.0.46\"\n LocalNodeState:\n $ref: \"#/definitions/LocalNodeState\"\n ControlAvailable:\n type: \"boolean\"\n default: false\n example: true\n Error:\n type: \"string\"\n default: \"\"\n RemoteManagers:\n description: |\n List of ID's and addresses of other managers in the swarm.\n type: \"array\"\n default: null\n x-nullable: true\n items:\n $ref: \"#/definitions/PeerNode\"\n example:\n - NodeID: \"71izy0goik036k48jg985xnds\"\n Addr: \"10.0.0.158:2377\"\n - NodeID: \"79y6h1o4gv8n120drcprv5nmc\"\n Addr: \"10.0.0.159:2377\"\n - NodeID: \"k67qz4598weg5unwwffg6z1m1\"\n Addr: \"10.0.0.46:2377\"\n Nodes:\n description: \"Total number of nodes in the swarm.\"\n type: \"integer\"\n x-nullable: true\n example: 4\n Managers:\n description: \"Total number of managers in the swarm.\"\n type: \"integer\"\n x-nullable: true\n example: 3\n Cluster:\n $ref: \"#/definitions/ClusterInfo\"\n\n LocalNodeState:\n description: \"Current local status of this node.\"\n type: \"string\"\n default: \"\"\n enum:\n - \"\"\n - \"inactive\"\n - \"pending\"\n - \"active\"\n - \"error\"\n - \"locked\"\n example: \"active\"\n\n PeerNode:\n description: \"Represents a peer-node in the swarm\"\n properties:\n NodeID:\n description: \"Unique identifier of for this node in the swarm.\"\n type: \"string\"\n Addr:\n description: |\n IP address and ports at which this node can be reached.\n type: \"string\"\n\n NetworkAttachmentConfig:\n description: |\n Specifies how a service should be attached to a particular network.\n type: \"object\"\n properties:\n Target:\n description: |\n The target network for attachment. Must be a network name or ID.\n type: \"string\"\n Aliases:\n description: |\n Discoverable alternate names for the service on this network.\n type: \"array\"\n items:\n type: \"string\"\n DriverOpts:\n description: |\n Driver attachment options for the network target.\n type: \"object\"\n additionalProperties:\n type: \"string\"\n\npaths:\n /containers/json:\n get:\n summary: \"List containers\"\n description: |\n Returns a list of containers. For details on the format, see the\n [inspect endpoint](#operation/ContainerInspect).\n\n Note that it uses a different, smaller representation of a container\n than inspecting a single container. For example, the list of linked\n containers is not propagated .\n operationId: \"ContainerList\"\n produces:\n - \"application/json\"\n parameters:\n - name: \"all\"\n in: \"query\"\n description: |\n Return all containers. By default, only running containers are shown.\n type: \"boolean\"\n default: false\n - name: \"limit\"\n in: \"query\"\n description: |\n Return this number of most recently created containers, including\n non-running ones.\n type: \"integer\"\n - name: \"size\"\n in: \"query\"\n description: |\n Return the size of container as fields `SizeRw` and `SizeRootFs`.\n type: \"boolean\"\n default: false\n - name: \"filters\"\n in: \"query\"\n description: |\n Filters to process on the container list, encoded as JSON (a\n `map[string][]string`). For example, `{\"status\": [\"paused\"]}` will\n only return paused containers.\n\n Available filters:\n\n - `ancestor`=(`[:]`, ``, or ``)\n - `before`=(`` or ``)\n - `expose`=(`[/]`|`/[]`)\n - `exited=` containers with exit code of ``\n - `health`=(`starting`|`healthy`|`unhealthy`|`none`)\n - `id=` a container's ID\n - `isolation=`(`default`|`process`|`hyperv`) (Windows daemon only)\n - `is-task=`(`true`|`false`)\n - `label=key` or `label=\"key=value\"` of a container label\n - `name=` a container's name\n - `network`=(`` or ``)\n - `publish`=(`[/]`|`/[]`)\n - `since`=(`` or ``)\n - `status=`(`created`|`restarting`|`running`|`removing`|`paused`|`exited`|`dead`)\n - `volume`=(`` or ``)\n type: \"string\"\n responses:\n 200:\n description: \"no error\"\n schema:\n $ref: \"#/definitions/ContainerSummary\"\n examples:\n application/json:\n - Id: \"8dfafdbc3a40\"\n Names:\n - \"/boring_feynman\"\n Image: \"ubuntu:latest\"\n ImageID: \"d74508fb6632491cea586a1fd7d748dfc5274cd6fdfedee309ecdcbc2bf5cb82\"\n Command: \"echo 1\"\n Created: 1367854155\n State: \"Exited\"\n Status: \"Exit 0\"\n Ports:\n - PrivatePort: 2222\n PublicPort: 3333\n Type: \"tcp\"\n Labels:\n com.example.vendor: \"Acme\"\n com.example.license: \"GPL\"\n com.example.version: \"1.0\"\n SizeRw: 12288\n SizeRootFs: 0\n HostConfig:\n NetworkMode: \"default\"\n NetworkSettings:\n Networks:\n bridge:\n NetworkID: \"7ea29fc1412292a2d7bba362f9253545fecdfa8ce9a6e37dd10ba8bee7129812\"\n EndpointID: \"2cdc4edb1ded3631c81f57966563e5c8525b81121bb3706a9a9a3ae102711f3f\"\n Gateway: \"172.17.0.1\"\n IPAddress: \"172.17.0.2\"\n IPPrefixLen: 16\n IPv6Gateway: \"\"\n GlobalIPv6Address: \"\"\n GlobalIPv6PrefixLen: 0\n MacAddress: \"02:42:ac:11:00:02\"\n Mounts:\n - Name: \"fac362...80535\"\n Source: \"/data\"\n Destination: \"/data\"\n Driver: \"local\"\n Mode: \"ro,Z\"\n RW: false\n Propagation: \"\"\n - Id: \"9cd87474be90\"\n Names:\n - \"/coolName\"\n Image: \"ubuntu:latest\"\n ImageID: \"d74508fb6632491cea586a1fd7d748dfc5274cd6fdfedee309ecdcbc2bf5cb82\"\n Command: \"echo 222222\"\n Created: 1367854155\n State: \"Exited\"\n Status: \"Exit 0\"\n Ports: []\n Labels: {}\n SizeRw: 12288\n SizeRootFs: 0\n HostConfig:\n NetworkMode: \"default\"\n NetworkSettings:\n Networks:\n bridge:\n NetworkID: \"7ea29fc1412292a2d7bba362f9253545fecdfa8ce9a6e37dd10ba8bee7129812\"\n EndpointID: \"88eaed7b37b38c2a3f0c4bc796494fdf51b270c2d22656412a2ca5d559a64d7a\"\n Gateway: \"172.17.0.1\"\n IPAddress: \"172.17.0.8\"\n IPPrefixLen: 16\n IPv6Gateway: \"\"\n GlobalIPv6Address: \"\"\n GlobalIPv6PrefixLen: 0\n MacAddress: \"02:42:ac:11:00:08\"\n Mounts: []\n - Id: \"3176a2479c92\"\n Names:\n - \"/sleepy_dog\"\n Image: \"ubuntu:latest\"\n ImageID: \"d74508fb6632491cea586a1fd7d748dfc5274cd6fdfedee309ecdcbc2bf5cb82\"\n Command: \"echo 3333333333333333\"\n Created: 1367854154\n State: \"Exited\"\n Status: \"Exit 0\"\n Ports: []\n Labels: {}\n SizeRw: 12288\n SizeRootFs: 0\n HostConfig:\n NetworkMode: \"default\"\n NetworkSettings:\n Networks:\n bridge:\n NetworkID: \"7ea29fc1412292a2d7bba362f9253545fecdfa8ce9a6e37dd10ba8bee7129812\"\n EndpointID: \"8b27c041c30326d59cd6e6f510d4f8d1d570a228466f956edf7815508f78e30d\"\n Gateway: \"172.17.0.1\"\n IPAddress: \"172.17.0.6\"\n IPPrefixLen: 16\n IPv6Gateway: \"\"\n GlobalIPv6Address: \"\"\n GlobalIPv6PrefixLen: 0\n MacAddress: \"02:42:ac:11:00:06\"\n Mounts: []\n - Id: \"4cb07b47f9fb\"\n Names:\n - \"/running_cat\"\n Image: \"ubuntu:latest\"\n ImageID: \"d74508fb6632491cea586a1fd7d748dfc5274cd6fdfedee309ecdcbc2bf5cb82\"\n Command: \"echo 444444444444444444444444444444444\"\n Created: 1367854152\n State: \"Exited\"\n Status: \"Exit 0\"\n Ports: []\n Labels: {}\n SizeRw: 12288\n SizeRootFs: 0\n HostConfig:\n NetworkMode: \"default\"\n NetworkSettings:\n Networks:\n bridge:\n NetworkID: \"7ea29fc1412292a2d7bba362f9253545fecdfa8ce9a6e37dd10ba8bee7129812\"\n EndpointID: \"d91c7b2f0644403d7ef3095985ea0e2370325cd2332ff3a3225c4247328e66e9\"\n Gateway: \"172.17.0.1\"\n IPAddress: \"172.17.0.5\"\n IPPrefixLen: 16\n IPv6Gateway: \"\"\n GlobalIPv6Address: \"\"\n GlobalIPv6PrefixLen: 0\n MacAddress: \"02:42:ac:11:00:05\"\n Mounts: []\n 400:\n description: \"bad parameter\"\n schema:\n $ref: \"#/definitions/ErrorResponse\"\n 500:\n description: \"server error\"\n schema:\n $ref: \"#/definitions/ErrorResponse\"\n tags: [\"Container\"]\n /containers/create:\n post:\n summary: \"Create a container\"\n operationId: \"ContainerCreate\"\n consumes:\n - \"application/json\"\n - \"application/octet-stream\"\n produces:\n - \"application/json\"\n parameters:\n - name: \"name\"\n in: \"query\"\n description: |\n Assign the specified name to the container. Must match\n `/?[a-zA-Z0-9][a-zA-Z0-9_.-]+`.\n type: \"string\"\n pattern: \"^/?[a-zA-Z0-9][a-zA-Z0-9_.-]+$\"\n - name: \"body\"\n in: \"body\"\n description: \"Container to create\"\n schema:\n allOf:\n - $ref: \"#/definitions/ContainerConfig\"\n - type: \"object\"\n properties:\n HostConfig:\n $ref: \"#/definitions/HostConfig\"\n NetworkingConfig:\n $ref: \"#/definitions/NetworkingConfig\"\n example:\n Hostname: \"\"\n Domainname: \"\"\n User: \"\"\n AttachStdin: false\n AttachStdout: true\n AttachStderr: true\n Tty: false\n OpenStdin: false\n StdinOnce: false\n Env:\n - \"FOO=bar\"\n - \"BAZ=quux\"\n Cmd:\n - \"date\"\n Entrypoint: \"\"\n Image: \"ubuntu\"\n Labels:\n com.example.vendor: \"Acme\"\n com.example.license: \"GPL\"\n com.example.version: \"1.0\"\n Volumes:\n /volumes/data: {}\n WorkingDir: \"\"\n NetworkDisabled: false\n MacAddress: \"12:34:56:78:9a:bc\"\n ExposedPorts:\n 22/tcp: {}\n StopSignal: \"SIGTERM\"\n StopTimeout: 10\n HostConfig:\n Binds:\n - \"/tmp:/tmp\"\n Links:\n - \"redis3:redis\"\n Memory: 0\n MemorySwap: 0\n MemoryReservation: 0\n KernelMemory: 0\n NanoCpus: 500000\n CpuPercent: 80\n CpuShares: 512\n CpuPeriod: 100000\n CpuRealtimePeriod: 1000000\n CpuRealtimeRuntime: 10000\n CpuQuota: 50000\n CpusetCpus: \"0,1\"\n CpusetMems: \"0,1\"\n MaximumIOps: 0\n MaximumIOBps: 0\n BlkioWeight: 300\n BlkioWeightDevice:\n - {}\n BlkioDeviceReadBps:\n - {}\n BlkioDeviceReadIOps:\n - {}\n BlkioDeviceWriteBps:\n - {}\n BlkioDeviceWriteIOps:\n - {}\n DeviceRequests:\n - Driver: \"nvidia\"\n Count: -1\n DeviceIDs\": [\"0\", \"1\", \"GPU-fef8089b-4820-abfc-e83e-94318197576e\"]\n Capabilities: [[\"gpu\", \"nvidia\", \"compute\"]]\n Options:\n property1: \"string\"\n property2: \"string\"\n MemorySwappiness: 60\n OomKillDisable: false\n OomScoreAdj: 500\n PidMode: \"\"\n PidsLimit: 0\n PortBindings:\n 22/tcp:\n - HostPort: \"11022\"\n PublishAllPorts: false\n Privileged: false\n ReadonlyRootfs: false\n Dns:\n - \"8.8.8.8\"\n DnsOptions:\n - \"\"\n DnsSearch:\n - \"\"\n VolumesFrom:\n - \"parent\"\n - \"other:ro\"\n CapAdd:\n - \"NET_ADMIN\"\n CapDrop:\n - \"MKNOD\"\n GroupAdd:\n - \"newgroup\"\n RestartPolicy:\n Name: \"\"\n MaximumRetryCount: 0\n AutoRemove: true\n NetworkMode: \"bridge\"\n Devices: []\n Ulimits:\n - {}\n LogConfig:\n Type: \"json-file\"\n Config: {}\n SecurityOpt: []\n StorageOpt: {}\n CgroupParent: \"\"\n VolumeDriver: \"\"\n ShmSize: 67108864\n NetworkingConfig:\n EndpointsConfig:\n isolated_nw:\n IPAMConfig:\n IPv4Address: \"172.20.30.33\"\n IPv6Address: \"2001:db8:abcd::3033\"\n LinkLocalIPs:\n - \"169.254.34.68\"\n - \"fe80::3468\"\n Links:\n - \"container_1\"\n - \"container_2\"\n Aliases:\n - \"server_x\"\n - \"server_y\"\n\n required: true\n responses:\n 201:\n description: \"Container created successfully\"\n schema:\n type: \"object\"\n title: \"ContainerCreateResponse\"\n description: \"OK response to ContainerCreate operation\"\n required: [Id, Warnings]\n properties:\n Id:\n description: \"The ID of the created container\"\n type: \"string\"\n x-nullable: false\n Warnings:\n description: \"Warnings encountered when creating the container\"\n type: \"array\"\n x-nullable: false\n items:\n type: \"string\"\n examples:\n application/json:\n Id: \"e90e34656806\"\n Warnings: []\n 400:\n description: \"bad parameter\"\n schema:\n $ref: \"#/definitions/ErrorResponse\"\n 404:\n description: \"no such image\"\n schema:\n $ref: \"#/definitions/ErrorResponse\"\n examples:\n application/json:\n message: \"No such image: c2ada9df5af8\"\n 409:\n description: \"conflict\"\n schema:\n $ref: \"#/definitions/ErrorResponse\"\n 500:\n description: \"server error\"\n schema:\n $ref: \"#/definitions/ErrorResponse\"\n tags: [\"Container\"]\n /containers/{id}/json:\n get:\n summary: \"Inspect a container\"\n description: \"Return low-level information about a container.\"\n operationId: \"ContainerInspect\"\n produces:\n - \"application/json\"\n responses:\n 200:\n description: \"no error\"\n schema:\n type: \"object\"\n title: \"ContainerInspectResponse\"\n properties:\n Id:\n description: \"The ID of the container\"\n type: \"string\"\n Created:\n description: \"The time the container was created\"\n type: \"string\"\n Path:\n description: \"The path to the command being run\"\n type: \"string\"\n Args:\n description: \"The arguments to the command being run\"\n type: \"array\"\n items:\n type: \"string\"\n State:\n x-nullable: true\n $ref: \"#/definitions/ContainerState\"\n Image:\n description: \"The container's image ID\"\n type: \"string\"\n ResolvConfPath:\n type: \"string\"\n HostnamePath:\n type: \"string\"\n HostsPath:\n type: \"string\"\n LogPath:\n type: \"string\"\n Name:\n type: \"string\"\n RestartCount:\n type: \"integer\"\n Driver:\n type: \"string\"\n Platform:\n type: \"string\"\n MountLabel:\n type: \"string\"\n ProcessLabel:\n type: \"string\"\n AppArmorProfile:\n type: \"string\"\n ExecIDs:\n description: \"IDs of exec instances that are running in the container.\"\n type: \"array\"\n items:\n type: \"string\"\n x-nullable: true\n HostConfig:\n $ref: \"#/definitions/HostConfig\"\n GraphDriver:\n $ref: \"#/definitions/GraphDriverData\"\n SizeRw:\n description: |\n The size of files that have been created or changed by this\n container.\n type: \"integer\"\n format: \"int64\"\n SizeRootFs:\n description: \"The total size of all the files in this container.\"\n type: \"integer\"\n format: \"int64\"\n Mounts:\n type: \"array\"\n items:\n $ref: \"#/definitions/MountPoint\"\n Config:\n $ref: \"#/definitions/ContainerConfig\"\n NetworkSettings:\n $ref: \"#/definitions/NetworkSettings\"\n examples:\n application/json:\n AppArmorProfile: \"\"\n Args:\n - \"-c\"\n - \"exit 9\"\n Config:\n AttachStderr: true\n AttachStdin: false\n AttachStdout: true\n Cmd:\n - \"/bin/sh\"\n - \"-c\"\n - \"exit 9\"\n Domainname: \"\"\n Env:\n - \"PATH=/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin\"\n Healthcheck:\n Test: [\"CMD-SHELL\", \"exit 0\"]\n Hostname: \"ba033ac44011\"\n Image: \"ubuntu\"\n Labels:\n com.example.vendor: \"Acme\"\n com.example.license: \"GPL\"\n com.example.version: \"1.0\"\n MacAddress: \"\"\n NetworkDisabled: false\n OpenStdin: false\n StdinOnce: false\n Tty: false\n User: \"\"\n Volumes:\n /volumes/data: {}\n WorkingDir: \"\"\n StopSignal: \"SIGTERM\"\n StopTimeout: 10\n Created: \"2015-01-06T15:47:31.485331387Z\"\n Driver: \"devicemapper\"\n ExecIDs:\n - \"b35395de42bc8abd327f9dd65d913b9ba28c74d2f0734eeeae84fa1c616a0fca\"\n - \"3fc1232e5cd20c8de182ed81178503dc6437f4e7ef12b52cc5e8de020652f1c4\"\n HostConfig:\n MaximumIOps: 0\n MaximumIOBps: 0\n BlkioWeight: 0\n BlkioWeightDevice:\n - {}\n BlkioDeviceReadBps:\n - {}\n BlkioDeviceWriteBps:\n - {}\n BlkioDeviceReadIOps:\n - {}\n BlkioDeviceWriteIOps:\n - {}\n ContainerIDFile: \"\"\n CpusetCpus: \"\"\n CpusetMems: \"\"\n CpuPercent: 80\n CpuShares: 0\n CpuPeriod: 100000\n CpuRealtimePeriod: 1000000\n CpuRealtimeRuntime: 10000\n Devices: []\n DeviceRequests:\n - Driver: \"nvidia\"\n Count: -1\n DeviceIDs\": [\"0\", \"1\", \"GPU-fef8089b-4820-abfc-e83e-94318197576e\"]\n Capabilities: [[\"gpu\", \"nvidia\", \"compute\"]]\n Options:\n property1: \"string\"\n property2: \"string\"\n IpcMode: \"\"\n LxcConf: []\n Memory: 0\n MemorySwap: 0\n MemoryReservation: 0\n KernelMemory: 0\n OomKillDisable: false\n OomScoreAdj: 500\n NetworkMode: \"bridge\"\n PidMode: \"\"\n PortBindings: {}\n Privileged: false\n ReadonlyRootfs: false\n PublishAllPorts: false\n RestartPolicy:\n MaximumRetryCount: 2\n Name: \"on-failure\"\n LogConfig:\n Type: \"json-file\"\n Sysctls:\n net.ipv4.ip_forward: \"1\"\n Ulimits:\n - {}\n VolumeDriver: \"\"\n ShmSize: 67108864\n HostnamePath: \"/var/lib/docker/containers/ba033ac4401106a3b513bc9d639eee123ad78ca3616b921167cd74b20e25ed39/hostname\"\n HostsPath: \"/var/lib/docker/containers/ba033ac4401106a3b513bc9d639eee123ad78ca3616b921167cd74b20e25ed39/hosts\"\n LogPath: \"/var/lib/docker/containers/1eb5fabf5a03807136561b3c00adcd2992b535d624d5e18b6cdc6a6844d9767b/1eb5fabf5a03807136561b3c00adcd2992b535d624d5e18b6cdc6a6844d9767b-json.log\"\n Id: \"ba033ac4401106a3b513bc9d639eee123ad78ca3616b921167cd74b20e25ed39\"\n Image: \"04c5d3b7b0656168630d3ba35d8889bd0e9caafcaeb3004d2bfbc47e7c5d35d2\"\n MountLabel: \"\"\n Name: \"/boring_euclid\"\n NetworkSettings:\n Bridge: \"\"\n SandboxID: \"\"\n HairpinMode: false\n LinkLocalIPv6Address: \"\"\n LinkLocalIPv6PrefixLen: 0\n SandboxKey: \"\"\n EndpointID: \"\"\n Gateway: \"\"\n GlobalIPv6Address: \"\"\n GlobalIPv6PrefixLen: 0\n IPAddress: \"\"\n IPPrefixLen: 0\n IPv6Gateway: \"\"\n MacAddress: \"\"\n Networks:\n bridge:\n NetworkID: \"7ea29fc1412292a2d7bba362f9253545fecdfa8ce9a6e37dd10ba8bee7129812\"\n EndpointID: \"7587b82f0dada3656fda26588aee72630c6fab1536d36e394b2bfbcf898c971d\"\n Gateway: \"172.17.0.1\"\n IPAddress: \"172.17.0.2\"\n IPPrefixLen: 16\n IPv6Gateway: \"\"\n GlobalIPv6Address: \"\"\n GlobalIPv6PrefixLen: 0\n MacAddress: \"02:42:ac:12:00:02\"\n Path: \"/bin/sh\"\n ProcessLabel: \"\"\n ResolvConfPath: \"/var/lib/docker/containers/ba033ac4401106a3b513bc9d639eee123ad78ca3616b921167cd74b20e25ed39/resolv.conf\"\n RestartCount: 1\n State:\n Error: \"\"\n ExitCode: 9\n FinishedAt: \"2015-01-06T15:47:32.080254511Z\"\n Health:\n Status: \"healthy\"\n FailingStreak: 0\n Log:\n - Start: \"2019-12-22T10:59:05.6385933Z\"\n End: \"2019-12-22T10:59:05.8078452Z\"\n ExitCode: 0\n Output: \"\"\n OOMKilled: false\n Dead: false\n Paused: false\n Pid: 0\n Restarting: false\n Running: true\n StartedAt: \"2015-01-06T15:47:32.072697474Z\"\n Status: \"running\"\n Mounts:\n - Name: \"fac362...80535\"\n Source: \"/data\"\n Destination: \"/data\"\n Driver: \"local\"\n Mode: \"ro,Z\"\n RW: false\n Propagation: \"\"\n 404:\n description: \"no such container\"\n schema:\n $ref: \"#/definitions/ErrorResponse\"\n examples:\n application/json:\n message: \"No such container: c2ada9df5af8\"\n 500:\n description: \"server error\"\n schema:\n $ref: \"#/definitions/ErrorResponse\"\n parameters:\n - name: \"id\"\n in: \"path\"\n required: true\n description: \"ID or name of the container\"\n type: \"string\"\n - name: \"size\"\n in: \"query\"\n type: \"boolean\"\n default: false\n description: \"Return the size of container as fields `SizeRw` and `SizeRootFs`\"\n tags: [\"Container\"]\n /containers/{id}/top:\n get:\n summary: \"List processes running inside a container\"\n description: |\n On Unix systems, this is done by running the `ps` command. This endpoint\n is not supported on Windows.\n operationId: \"ContainerTop\"\n responses:\n 200:\n description: \"no error\"\n schema:\n type: \"object\"\n title: \"ContainerTopResponse\"\n description: \"OK response to ContainerTop operation\"\n properties:\n Titles:\n description: \"The ps column titles\"\n type: \"array\"\n items:\n type: \"string\"\n Processes:\n description: |\n Each process running in the container, where each is process\n is an array of values corresponding to the titles.\n type: \"array\"\n items:\n type: \"array\"\n items:\n type: \"string\"\n examples:\n application/json:\n Titles:\n - \"UID\"\n - \"PID\"\n - \"PPID\"\n - \"C\"\n - \"STIME\"\n - \"TTY\"\n - \"TIME\"\n - \"CMD\"\n Processes:\n -\n - \"root\"\n - \"13642\"\n - \"882\"\n - \"0\"\n - \"17:03\"\n - \"pts/0\"\n - \"00:00:00\"\n - \"/bin/bash\"\n -\n - \"root\"\n - \"13735\"\n - \"13642\"\n - \"0\"\n - \"17:06\"\n - \"pts/0\"\n - \"00:00:00\"\n - \"sleep 10\"\n 404:\n description: \"no such container\"\n schema:\n $ref: \"#/definitions/ErrorResponse\"\n examples:\n application/json:\n message: \"No such container: c2ada9df5af8\"\n 500:\n description: \"server error\"\n schema:\n $ref: \"#/definitions/ErrorResponse\"\n parameters:\n - name: \"id\"\n in: \"path\"\n required: true\n description: \"ID or name of the container\"\n type: \"string\"\n - name: \"ps_args\"\n in: \"query\"\n description: \"The arguments to pass to `ps`. For example, `aux`\"\n type: \"string\"\n default: \"-ef\"\n tags: [\"Container\"]\n /containers/{id}/logs:\n get:\n summary: \"Get container logs\"\n description: |\n Get `stdout` and `stderr` logs from a container.\n\n Note: This endpoint works only for containers with the `json-file` or\n `journald` logging driver.\n operationId: \"ContainerLogs\"\n responses:\n 200:\n description: |\n logs returned as a stream in response body.\n For the stream format, [see the documentation for the attach endpoint](#operation/ContainerAttach).\n Note that unlike the attach endpoint, the logs endpoint does not\n upgrade the connection and does not set Content-Type.\n schema:\n type: \"string\"\n format: \"binary\"\n 404:\n description: \"no such container\"\n schema:\n $ref: \"#/definitions/ErrorResponse\"\n examples:\n application/json:\n message: \"No such container: c2ada9df5af8\"\n 500:\n description: \"server error\"\n schema:\n $ref: \"#/definitions/ErrorResponse\"\n parameters:\n - name: \"id\"\n in: \"path\"\n required: true\n description: \"ID or name of the container\"\n type: \"string\"\n - name: \"follow\"\n in: \"query\"\n description: \"Keep connection after returning logs.\"\n type: \"boolean\"\n default: false\n - name: \"stdout\"\n in: \"query\"\n description: \"Return logs from `stdout`\"\n type: \"boolean\"\n default: false\n - name: \"stderr\"\n in: \"query\"\n description: \"Return logs from `stderr`\"\n type: \"boolean\"\n default: false\n - name: \"since\"\n in: \"query\"\n description: \"Only return logs since this time, as a UNIX timestamp\"\n type: \"integer\"\n default: 0\n - name: \"until\"\n in: \"query\"\n description: \"Only return logs before this time, as a UNIX timestamp\"\n type: \"integer\"\n default: 0\n - name: \"timestamps\"\n in: \"query\"\n description: \"Add timestamps to every log line\"\n type: \"boolean\"\n default: false\n - name: \"tail\"\n in: \"query\"\n description: |\n Only return this number of log lines from the end of the logs.\n Specify as an integer or `all` to output all log lines.\n type: \"string\"\n default: \"all\"\n tags: [\"Container\"]\n /containers/{id}/changes:\n get:\n summary: \"Get changes on a container’s filesystem\"\n description: |\n Returns which files in a container's filesystem have been added, deleted,\n or modified. The `Kind` of modification can be one of:\n\n - `0`: Modified\n - `1`: Added\n - `2`: Deleted\n operationId: \"ContainerChanges\"\n produces: [\"application/json\"]\n responses:\n 200:\n description: \"The list of changes\"\n schema:\n type: \"array\"\n items:\n type: \"object\"\n x-go-name: \"ContainerChangeResponseItem\"\n title: \"ContainerChangeResponseItem\"\n description: \"change item in response to ContainerChanges operation\"\n required: [Path, Kind]\n properties:\n Path:\n description: \"Path to file that has changed\"\n type: \"string\"\n x-nullable: false\n Kind:\n description: \"Kind of change\"\n type: \"integer\"\n format: \"uint8\"\n enum: [0, 1, 2]\n x-nullable: false\n examples:\n application/json:\n - Path: \"/dev\"\n Kind: 0\n - Path: \"/dev/kmsg\"\n Kind: 1\n - Path: \"/test\"\n Kind: 1\n 404:\n description: \"no such container\"\n schema:\n $ref: \"#/definitions/ErrorResponse\"\n examples:\n application/json:\n message: \"No such container: c2ada9df5af8\"\n 500:\n description: \"server error\"\n schema:\n $ref: \"#/definitions/ErrorResponse\"\n parameters:\n - name: \"id\"\n in: \"path\"\n required: true\n description: \"ID or name of the container\"\n type: \"string\"\n tags: [\"Container\"]\n /containers/{id}/export:\n get:\n summary: \"Export a container\"\n description: \"Export the contents of a container as a tarball.\"\n operationId: \"ContainerExport\"\n produces:\n - \"application/octet-stream\"\n responses:\n 200:\n description: \"no error\"\n 404:\n description: \"no such container\"\n schema:\n $ref: \"#/definitions/ErrorResponse\"\n examples:\n application/json:\n message: \"No such container: c2ada9df5af8\"\n 500:\n description: \"server error\"\n schema:\n $ref: \"#/definitions/ErrorResponse\"\n parameters:\n - name: \"id\"\n in: \"path\"\n required: true\n description: \"ID or name of the container\"\n type: \"string\"\n tags: [\"Container\"]\n /containers/{id}/stats:\n get:\n summary: \"Get container stats based on resource usage\"\n description: |\n This endpoint returns a live stream of a container’s resource usage\n statistics.\n\n The `precpu_stats` is the CPU statistic of the *previous* read, and is\n used to calculate the CPU usage percentage. It is not an exact copy\n of the `cpu_stats` field.\n\n If either `precpu_stats.online_cpus` or `cpu_stats.online_cpus` is\n nil then for compatibility with older daemons the length of the\n corresponding `cpu_usage.percpu_usage` array should be used.\n\n On a cgroup v2 host, the following fields are not set\n * `blkio_stats`: all fields other than `io_service_bytes_recursive`\n * `cpu_stats`: `cpu_usage.percpu_usage`\n * `memory_stats`: `max_usage` and `failcnt`\n Also, `memory_stats.stats` fields are incompatible with cgroup v1.\n\n To calculate the values shown by the `stats` command of the docker cli tool\n the following formulas can be used:\n * used_memory = `memory_stats.usage - memory_stats.stats.cache`\n * available_memory = `memory_stats.limit`\n * Memory usage % = `(used_memory / available_memory) * 100.0`\n * cpu_delta = `cpu_stats.cpu_usage.total_usage - precpu_stats.cpu_usage.total_usage`\n * system_cpu_delta = `cpu_stats.system_cpu_usage - precpu_stats.system_cpu_usage`\n * number_cpus = `lenght(cpu_stats.cpu_usage.percpu_usage)` or `cpu_stats.online_cpus`\n * CPU usage % = `(cpu_delta / system_cpu_delta) * number_cpus * 100.0`\n operationId: \"ContainerStats\"\n produces: [\"application/json\"]\n responses:\n 200:\n description: \"no error\"\n schema:\n type: \"object\"\n examples:\n application/json:\n read: \"2015-01-08T22:57:31.547920715Z\"\n pids_stats:\n current: 3\n networks:\n eth0:\n rx_bytes: 5338\n rx_dropped: 0\n rx_errors: 0\n rx_packets: 36\n tx_bytes: 648\n tx_dropped: 0\n tx_errors: 0\n tx_packets: 8\n eth5:\n rx_bytes: 4641\n rx_dropped: 0\n rx_errors: 0\n rx_packets: 26\n tx_bytes: 690\n tx_dropped: 0\n tx_errors: 0\n tx_packets: 9\n memory_stats:\n stats:\n total_pgmajfault: 0\n cache: 0\n mapped_file: 0\n total_inactive_file: 0\n pgpgout: 414\n rss: 6537216\n total_mapped_file: 0\n writeback: 0\n unevictable: 0\n pgpgin: 477\n total_unevictable: 0\n pgmajfault: 0\n total_rss: 6537216\n total_rss_huge: 6291456\n total_writeback: 0\n total_inactive_anon: 0\n rss_huge: 6291456\n hierarchical_memory_limit: 67108864\n total_pgfault: 964\n total_active_file: 0\n active_anon: 6537216\n total_active_anon: 6537216\n total_pgpgout: 414\n total_cache: 0\n inactive_anon: 0\n active_file: 0\n pgfault: 964\n inactive_file: 0\n total_pgpgin: 477\n max_usage: 6651904\n usage: 6537216\n failcnt: 0\n limit: 67108864\n blkio_stats: {}\n cpu_stats:\n cpu_usage:\n percpu_usage:\n - 8646879\n - 24472255\n - 36438778\n - 30657443\n usage_in_usermode: 50000000\n total_usage: 100215355\n usage_in_kernelmode: 30000000\n system_cpu_usage: 739306590000000\n online_cpus: 4\n throttling_data:\n periods: 0\n throttled_periods: 0\n throttled_time: 0\n precpu_stats:\n cpu_usage:\n percpu_usage:\n - 8646879\n - 24350896\n - 36438778\n - 30657443\n usage_in_usermode: 50000000\n total_usage: 100093996\n usage_in_kernelmode: 30000000\n system_cpu_usage: 9492140000000\n online_cpus: 4\n throttling_data:\n periods: 0\n throttled_periods: 0\n throttled_time: 0\n 404:\n description: \"no such container\"\n schema:\n $ref: \"#/definitions/ErrorResponse\"\n examples:\n application/json:\n message: \"No such container: c2ada9df5af8\"\n 500:\n description: \"server error\"\n schema:\n $ref: \"#/definitions/ErrorResponse\"\n parameters:\n - name: \"id\"\n in: \"path\"\n required: true\n description: \"ID or name of the container\"\n type: \"string\"\n - name: \"stream\"\n in: \"query\"\n description: |\n Stream the output. If false, the stats will be output once and then\n it will disconnect.\n type: \"boolean\"\n default: true\n - name: \"one-shot\"\n in: \"query\"\n description: |\n Only get a single stat instead of waiting for 2 cycles. Must be used\n with `stream=false`.\n type: \"boolean\"\n default: false\n tags: [\"Container\"]\n /containers/{id}/resize:\n post:\n summary: \"Resize a container TTY\"\n description: \"Resize the TTY for a container.\"\n operationId: \"ContainerResize\"\n consumes:\n - \"application/octet-stream\"\n produces:\n - \"text/plain\"\n responses:\n 200:\n description: \"no error\"\n 404:\n description: \"no such container\"\n schema:\n $ref: \"#/definitions/ErrorResponse\"\n examples:\n application/json:\n message: \"No such container: c2ada9df5af8\"\n 500:\n description: \"cannot resize container\"\n schema:\n $ref: \"#/definitions/ErrorResponse\"\n parameters:\n - name: \"id\"\n in: \"path\"\n required: true\n description: \"ID or name of the container\"\n type: \"string\"\n - name: \"h\"\n in: \"query\"\n description: \"Height of the TTY session in characters\"\n type: \"integer\"\n - name: \"w\"\n in: \"query\"\n description: \"Width of the TTY session in characters\"\n type: \"integer\"\n tags: [\"Container\"]\n /containers/{id}/start:\n post:\n summary: \"Start a container\"\n operationId: \"ContainerStart\"\n responses:\n 204:\n description: \"no error\"\n 304:\n description: \"container already started\"\n 404:\n description: \"no such container\"\n schema:\n $ref: \"#/definitions/ErrorResponse\"\n examples:\n application/json:\n message: \"No such container: c2ada9df5af8\"\n 500:\n description: \"server error\"\n schema:\n $ref: \"#/definitions/ErrorResponse\"\n parameters:\n - name: \"id\"\n in: \"path\"\n required: true\n description: \"ID or name of the container\"\n type: \"string\"\n - name: \"detachKeys\"\n in: \"query\"\n description: |\n Override the key sequence for detaching a container. Format is a\n single character `[a-Z]` or `ctrl-` where `` is one\n of: `a-z`, `@`, `^`, `[`, `,` or `_`.\n type: \"string\"\n tags: [\"Container\"]\n /containers/{id}/stop:\n post:\n summary: \"Stop a container\"\n operationId: \"ContainerStop\"\n responses:\n 204:\n description: \"no error\"\n 304:\n description: \"container already stopped\"\n 404:\n description: \"no such container\"\n schema:\n $ref: \"#/definitions/ErrorResponse\"\n examples:\n application/json:\n message: \"No such container: c2ada9df5af8\"\n 500:\n description: \"server error\"\n schema:\n $ref: \"#/definitions/ErrorResponse\"\n parameters:\n - name: \"id\"\n in: \"path\"\n required: true\n description: \"ID or name of the container\"\n type: \"string\"\n - name: \"t\"\n in: \"query\"\n description: \"Number of seconds to wait before killing the container\"\n type: \"integer\"\n tags: [\"Container\"]\n /containers/{id}/restart:\n post:\n summary: \"Restart a container\"\n operationId: \"ContainerRestart\"\n responses:\n 204:\n description: \"no error\"\n 404:\n description: \"no such container\"\n schema:\n $ref: \"#/definitions/ErrorResponse\"\n examples:\n application/json:\n message: \"No such container: c2ada9df5af8\"\n 500:\n description: \"server error\"\n schema:\n $ref: \"#/definitions/ErrorResponse\"\n parameters:\n - name: \"id\"\n in: \"path\"\n required: true\n description: \"ID or name of the container\"\n type: \"string\"\n - name: \"t\"\n in: \"query\"\n description: \"Number of seconds to wait before killing the container\"\n type: \"integer\"\n tags: [\"Container\"]\n /containers/{id}/kill:\n post:\n summary: \"Kill a container\"\n description: |\n Send a POSIX signal to a container, defaulting to killing to the\n container.\n operationId: \"ContainerKill\"\n responses:\n 204:\n description: \"no error\"\n 404:\n description: \"no such container\"\n schema:\n $ref: \"#/definitions/ErrorResponse\"\n examples:\n application/json:\n message: \"No such container: c2ada9df5af8\"\n 409:\n description: \"container is not running\"\n schema:\n $ref: \"#/definitions/ErrorResponse\"\n examples:\n application/json:\n message: \"Container d37cde0fe4ad63c3a7252023b2f9800282894247d145cb5933ddf6e52cc03a28 is not running\"\n 500:\n description: \"server error\"\n schema:\n $ref: \"#/definitions/ErrorResponse\"\n parameters:\n - name: \"id\"\n in: \"path\"\n required: true\n description: \"ID or name of the container\"\n type: \"string\"\n - name: \"signal\"\n in: \"query\"\n description: \"Signal to send to the container as an integer or string (e.g. `SIGINT`)\"\n type: \"string\"\n default: \"SIGKILL\"\n tags: [\"Container\"]\n /containers/{id}/update:\n post:\n summary: \"Update a container\"\n description: |\n Change various configuration options of a container without having to\n recreate it.\n operationId: \"ContainerUpdate\"\n consumes: [\"application/json\"]\n produces: [\"application/json\"]\n responses:\n 200:\n description: \"The container has been updated.\"\n schema:\n type: \"object\"\n title: \"ContainerUpdateResponse\"\n description: \"OK response to ContainerUpdate operation\"\n properties:\n Warnings:\n type: \"array\"\n items:\n type: \"string\"\n 404:\n description: \"no such container\"\n schema:\n $ref: \"#/definitions/ErrorResponse\"\n examples:\n application/json:\n message: \"No such container: c2ada9df5af8\"\n 500:\n description: \"server error\"\n schema:\n $ref: \"#/definitions/ErrorResponse\"\n parameters:\n - name: \"id\"\n in: \"path\"\n required: true\n description: \"ID or name of the container\"\n type: \"string\"\n - name: \"update\"\n in: \"body\"\n required: true\n schema:\n allOf:\n - $ref: \"#/definitions/Resources\"\n - type: \"object\"\n properties:\n RestartPolicy:\n $ref: \"#/definitions/RestartPolicy\"\n example:\n BlkioWeight: 300\n CpuShares: 512\n CpuPeriod: 100000\n CpuQuota: 50000\n CpuRealtimePeriod: 1000000\n CpuRealtimeRuntime: 10000\n CpusetCpus: \"0,1\"\n CpusetMems: \"0\"\n Memory: 314572800\n MemorySwap: 514288000\n MemoryReservation: 209715200\n KernelMemory: 52428800\n RestartPolicy:\n MaximumRetryCount: 4\n Name: \"on-failure\"\n tags: [\"Container\"]\n /containers/{id}/rename:\n post:\n summary: \"Rename a container\"\n operationId: \"ContainerRename\"\n responses:\n 204:\n description: \"no error\"\n 404:\n description: \"no such container\"\n schema:\n $ref: \"#/definitions/ErrorResponse\"\n examples:\n application/json:\n message: \"No such container: c2ada9df5af8\"\n 409:\n description: \"name already in use\"\n schema:\n $ref: \"#/definitions/ErrorResponse\"\n 500:\n description: \"server error\"\n schema:\n $ref: \"#/definitions/ErrorResponse\"\n parameters:\n - name: \"id\"\n in: \"path\"\n required: true\n description: \"ID or name of the container\"\n type: \"string\"\n - name: \"name\"\n in: \"query\"\n required: true\n description: \"New name for the container\"\n type: \"string\"\n tags: [\"Container\"]\n /containers/{id}/pause:\n post:\n summary: \"Pause a container\"\n description: |\n Use the freezer cgroup to suspend all processes in a container.\n\n Traditionally, when suspending a process the `SIGSTOP` signal is used,\n which is observable by the process being suspended. With the freezer\n cgroup the process is unaware, and unable to capture, that it is being\n suspended, and subsequently resumed.\n operationId: \"ContainerPause\"\n responses:\n 204:\n description: \"no error\"\n 404:\n description: \"no such container\"\n schema:\n $ref: \"#/definitions/ErrorResponse\"\n examples:\n application/json:\n message: \"No such container: c2ada9df5af8\"\n 500:\n description: \"server error\"\n schema:\n $ref: \"#/definitions/ErrorResponse\"\n parameters:\n - name: \"id\"\n in: \"path\"\n required: true\n description: \"ID or name of the container\"\n type: \"string\"\n tags: [\"Container\"]\n /containers/{id}/unpause:\n post:\n summary: \"Unpause a container\"\n description: \"Resume a container which has been paused.\"\n operationId: \"ContainerUnpause\"\n responses:\n 204:\n description: \"no error\"\n 404:\n description: \"no such container\"\n schema:\n $ref: \"#/definitions/ErrorResponse\"\n examples:\n application/json:\n message: \"No such container: c2ada9df5af8\"\n 500:\n description: \"server error\"\n schema:\n $ref: \"#/definitions/ErrorResponse\"\n parameters:\n - name: \"id\"\n in: \"path\"\n required: true\n description: \"ID or name of the container\"\n type: \"string\"\n tags: [\"Container\"]\n /containers/{id}/attach:\n post:\n summary: \"Attach to a container\"\n description: |\n Attach to a container to read its output or send it input. You can attach\n to the same container multiple times and you can reattach to containers\n that have been detached.\n\n Either the `stream` or `logs` parameter must be `true` for this endpoint\n to do anything.\n\n See the [documentation for the `docker attach` command](https://docs.docker.com/engine/reference/commandline/attach/)\n for more details.\n\n ### Hijacking\n\n This endpoint hijacks the HTTP connection to transport `stdin`, `stdout`,\n and `stderr` on the same socket.\n\n This is the response from the daemon for an attach request:\n\n ```\n HTTP/1.1 200 OK\n Content-Type: application/vnd.docker.raw-stream\n\n [STREAM]\n ```\n\n After the headers and two new lines, the TCP connection can now be used\n for raw, bidirectional communication between the client and server.\n\n To hint potential proxies about connection hijacking, the Docker client\n can also optionally send connection upgrade headers.\n\n For example, the client sends this request to upgrade the connection:\n\n ```\n POST /containers/16253994b7c4/attach?stream=1&stdout=1 HTTP/1.1\n Upgrade: tcp\n Connection: Upgrade\n ```\n\n The Docker daemon will respond with a `101 UPGRADED` response, and will\n similarly follow with the raw stream:\n\n ```\n HTTP/1.1 101 UPGRADED\n Content-Type: application/vnd.docker.raw-stream\n Connection: Upgrade\n Upgrade: tcp\n\n [STREAM]\n ```\n\n ### Stream format\n\n When the TTY setting is disabled in [`POST /containers/create`](#operation/ContainerCreate),\n the stream over the hijacked connected is multiplexed to separate out\n `stdout` and `stderr`. The stream consists of a series of frames, each\n containing a header and a payload.\n\n The header contains the information which the stream writes (`stdout` or\n `stderr`). It also contains the size of the associated frame encoded in\n the last four bytes (`uint32`).\n\n It is encoded on the first eight bytes like this:\n\n ```go\n header := [8]byte{STREAM_TYPE, 0, 0, 0, SIZE1, SIZE2, SIZE3, SIZE4}\n ```\n\n `STREAM_TYPE` can be:\n\n - 0: `stdin` (is written on `stdout`)\n - 1: `stdout`\n - 2: `stderr`\n\n `SIZE1, SIZE2, SIZE3, SIZE4` are the four bytes of the `uint32` size\n encoded as big endian.\n\n Following the header is the payload, which is the specified number of\n bytes of `STREAM_TYPE`.\n\n The simplest way to implement this protocol is the following:\n\n 1. Read 8 bytes.\n 2. Choose `stdout` or `stderr` depending on the first byte.\n 3. Extract the frame size from the last four bytes.\n 4. Read the extracted size and output it on the correct output.\n 5. Goto 1.\n\n ### Stream format when using a TTY\n\n When the TTY setting is enabled in [`POST /containers/create`](#operation/ContainerCreate),\n the stream is not multiplexed. The data exchanged over the hijacked\n connection is simply the raw data from the process PTY and client's\n `stdin`.\n\n operationId: \"ContainerAttach\"\n produces:\n - \"application/vnd.docker.raw-stream\"\n responses:\n 101:\n description: \"no error, hints proxy about hijacking\"\n 200:\n description: \"no error, no upgrade header found\"\n 400:\n description: \"bad parameter\"\n schema:\n $ref: \"#/definitions/ErrorResponse\"\n 404:\n description: \"no such container\"\n schema:\n $ref: \"#/definitions/ErrorResponse\"\n examples:\n application/json:\n message: \"No such container: c2ada9df5af8\"\n 500:\n description: \"server error\"\n schema:\n $ref: \"#/definitions/ErrorResponse\"\n parameters:\n - name: \"id\"\n in: \"path\"\n required: true\n description: \"ID or name of the container\"\n type: \"string\"\n - name: \"detachKeys\"\n in: \"query\"\n description: |\n Override the key sequence for detaching a container.Format is a single\n character `[a-Z]` or `ctrl-` where `` is one of: `a-z`,\n `@`, `^`, `[`, `,` or `_`.\n type: \"string\"\n - name: \"logs\"\n in: \"query\"\n description: |\n Replay previous logs from the container.\n\n This is useful for attaching to a container that has started and you\n want to output everything since the container started.\n\n If `stream` is also enabled, once all the previous output has been\n returned, it will seamlessly transition into streaming current\n output.\n type: \"boolean\"\n default: false\n - name: \"stream\"\n in: \"query\"\n description: |\n Stream attached streams from the time the request was made onwards.\n type: \"boolean\"\n default: false\n - name: \"stdin\"\n in: \"query\"\n description: \"Attach to `stdin`\"\n type: \"boolean\"\n default: false\n - name: \"stdout\"\n in: \"query\"\n description: \"Attach to `stdout`\"\n type: \"boolean\"\n default: false\n - name: \"stderr\"\n in: \"query\"\n description: \"Attach to `stderr`\"\n type: \"boolean\"\n default: false\n tags: [\"Container\"]\n /containers/{id}/attach/ws:\n get:\n summary: \"Attach to a container via a websocket\"\n operationId: \"ContainerAttachWebsocket\"\n responses:\n 101:\n description: \"no error, hints proxy about hijacking\"\n 200:\n description: \"no error, no upgrade header found\"\n 400:\n description: \"bad parameter\"\n schema:\n $ref: \"#/definitions/ErrorResponse\"\n 404:\n description: \"no such container\"\n schema:\n $ref: \"#/definitions/ErrorResponse\"\n examples:\n application/json:\n message: \"No such container: c2ada9df5af8\"\n 500:\n description: \"server error\"\n schema:\n $ref: \"#/definitions/ErrorResponse\"\n parameters:\n - name: \"id\"\n in: \"path\"\n required: true\n description: \"ID or name of the container\"\n type: \"string\"\n - name: \"detachKeys\"\n in: \"query\"\n description: |\n Override the key sequence for detaching a container.Format is a single\n character `[a-Z]` or `ctrl-` where `` is one of: `a-z`,\n `@`, `^`, `[`, `,`, or `_`.\n type: \"string\"\n - name: \"logs\"\n in: \"query\"\n description: \"Return logs\"\n type: \"boolean\"\n default: false\n - name: \"stream\"\n in: \"query\"\n description: \"Return stream\"\n type: \"boolean\"\n default: false\n - name: \"stdin\"\n in: \"query\"\n description: \"Attach to `stdin`\"\n type: \"boolean\"\n default: false\n - name: \"stdout\"\n in: \"query\"\n description: \"Attach to `stdout`\"\n type: \"boolean\"\n default: false\n - name: \"stderr\"\n in: \"query\"\n description: \"Attach to `stderr`\"\n type: \"boolean\"\n default: false\n tags: [\"Container\"]\n /containers/{id}/wait:\n post:\n summary: \"Wait for a container\"\n description: \"Block until a container stops, then returns the exit code.\"\n operationId: \"ContainerWait\"\n produces: [\"application/json\"]\n responses:\n 200:\n description: \"The container has exit.\"\n schema:\n type: \"object\"\n title: \"ContainerWaitResponse\"\n description: \"OK response to ContainerWait operation\"\n required: [StatusCode]\n properties:\n StatusCode:\n description: \"Exit code of the container\"\n type: \"integer\"\n x-nullable: false\n Error:\n description: \"container waiting error, if any\"\n type: \"object\"\n properties:\n Message:\n description: \"Details of an error\"\n type: \"string\"\n 404:\n description: \"no such container\"\n schema:\n $ref: \"#/definitions/ErrorResponse\"\n examples:\n application/json:\n message: \"No such container: c2ada9df5af8\"\n 500:\n description: \"server error\"\n schema:\n $ref: \"#/definitions/ErrorResponse\"\n parameters:\n - name: \"id\"\n in: \"path\"\n required: true\n description: \"ID or name of the container\"\n type: \"string\"\n - name: \"condition\"\n in: \"query\"\n description: |\n Wait until a container state reaches the given condition, either\n 'not-running' (default), 'next-exit', or 'removed'.\n type: \"string\"\n default: \"not-running\"\n tags: [\"Container\"]\n /containers/{id}:\n delete:\n summary: \"Remove a container\"\n operationId: \"ContainerDelete\"\n responses:\n 204:\n description: \"no error\"\n 400:\n description: \"bad parameter\"\n schema:\n $ref: \"#/definitions/ErrorResponse\"\n 404:\n description: \"no such container\"\n schema:\n $ref: \"#/definitions/ErrorResponse\"\n examples:\n application/json:\n message: \"No such container: c2ada9df5af8\"\n 409:\n description: \"conflict\"\n schema:\n $ref: \"#/definitions/ErrorResponse\"\n examples:\n application/json:\n message: |\n You cannot remove a running container: c2ada9df5af8. Stop the\n container before attempting removal or force remove\n 500:\n description: \"server error\"\n schema:\n $ref: \"#/definitions/ErrorResponse\"\n parameters:\n - name: \"id\"\n in: \"path\"\n required: true\n description: \"ID or name of the container\"\n type: \"string\"\n - name: \"v\"\n in: \"query\"\n description: \"Remove anonymous volumes associated with the container.\"\n type: \"boolean\"\n default: false\n - name: \"force\"\n in: \"query\"\n description: \"If the container is running, kill it before removing it.\"\n type: \"boolean\"\n default: false\n - name: \"link\"\n in: \"query\"\n description: \"Remove the specified link associated with the container.\"\n type: \"boolean\"\n default: false\n tags: [\"Container\"]\n /containers/{id}/archive:\n head:\n summary: \"Get information about files in a container\"\n description: |\n A response header `X-Docker-Container-Path-Stat` is returned, containing\n a base64 - encoded JSON object with some filesystem header information\n about the path.\n operationId: \"ContainerArchiveInfo\"\n responses:\n 200:\n description: \"no error\"\n headers:\n X-Docker-Container-Path-Stat:\n type: \"string\"\n description: |\n A base64 - encoded JSON object with some filesystem header\n information about the path\n 400:\n description: \"Bad parameter\"\n schema:\n allOf:\n - $ref: \"#/definitions/ErrorResponse\"\n - type: \"object\"\n properties:\n message:\n description: |\n The error message. Either \"must specify path parameter\"\n (path cannot be empty) or \"not a directory\" (path was\n asserted to be a directory but exists as a file).\n type: \"string\"\n x-nullable: false\n 404:\n description: \"Container or path does not exist\"\n schema:\n $ref: \"#/definitions/ErrorResponse\"\n examples:\n application/json:\n message: \"No such container: c2ada9df5af8\"\n 500:\n description: \"Server error\"\n schema:\n $ref: \"#/definitions/ErrorResponse\"\n parameters:\n - name: \"id\"\n in: \"path\"\n required: true\n description: \"ID or name of the container\"\n type: \"string\"\n - name: \"path\"\n in: \"query\"\n required: true\n description: \"Resource in the container’s filesystem to archive.\"\n type: \"string\"\n tags: [\"Container\"]\n get:\n summary: \"Get an archive of a filesystem resource in a container\"\n description: \"Get a tar archive of a resource in the filesystem of container id.\"\n operationId: \"ContainerArchive\"\n produces: [\"application/x-tar\"]\n responses:\n 200:\n description: \"no error\"\n 400:\n description: \"Bad parameter\"\n schema:\n allOf:\n - $ref: \"#/definitions/ErrorResponse\"\n - type: \"object\"\n properties:\n message:\n description: |\n The error message. Either \"must specify path parameter\"\n (path cannot be empty) or \"not a directory\" (path was\n asserted to be a directory but exists as a file).\n type: \"string\"\n x-nullable: false\n 404:\n description: \"Container or path does not exist\"\n schema:\n $ref: \"#/definitions/ErrorResponse\"\n examples:\n application/json:\n message: \"No such container: c2ada9df5af8\"\n 500:\n description: \"server error\"\n schema:\n $ref: \"#/definitions/ErrorResponse\"\n parameters:\n - name: \"id\"\n in: \"path\"\n required: true\n description: \"ID or name of the container\"\n type: \"string\"\n - name: \"path\"\n in: \"query\"\n required: true\n description: \"Resource in the container’s filesystem to archive.\"\n type: \"string\"\n tags: [\"Container\"]\n put:\n summary: \"Extract an archive of files or folders to a directory in a container\"\n description: \"Upload a tar archive to be extracted to a path in the filesystem of container id.\"\n operationId: \"PutContainerArchive\"\n consumes: [\"application/x-tar\", \"application/octet-stream\"]\n responses:\n 200:\n description: \"The content was extracted successfully\"\n 400:\n description: \"Bad parameter\"\n schema:\n $ref: \"#/definitions/ErrorResponse\"\n 403:\n description: \"Permission denied, the volume or container rootfs is marked as read-only.\"\n schema:\n $ref: \"#/definitions/ErrorResponse\"\n 404:\n description: \"No such container or path does not exist inside the container\"\n schema:\n $ref: \"#/definitions/ErrorResponse\"\n examples:\n application/json:\n message: \"No such container: c2ada9df5af8\"\n 500:\n description: \"Server error\"\n schema:\n $ref: \"#/definitions/ErrorResponse\"\n parameters:\n - name: \"id\"\n in: \"path\"\n required: true\n description: \"ID or name of the container\"\n type: \"string\"\n - name: \"path\"\n in: \"query\"\n required: true\n description: \"Path to a directory in the container to extract the archive’s contents into. \"\n type: \"string\"\n - name: \"noOverwriteDirNonDir\"\n in: \"query\"\n description: |\n If `1`, `true`, or `True` then it will be an error if unpacking the\n given content would cause an existing directory to be replaced with\n a non-directory and vice versa.\n type: \"string\"\n - name: \"copyUIDGID\"\n in: \"query\"\n description: |\n If `1`, `true`, then it will copy UID/GID maps to the dest file or\n dir\n type: \"string\"\n - name: \"inputStream\"\n in: \"body\"\n required: true\n description: |\n The input stream must be a tar archive compressed with one of the\n following algorithms: `identity` (no compression), `gzip`, `bzip2`,\n or `xz`.\n schema:\n type: \"string\"\n format: \"binary\"\n tags: [\"Container\"]\n /containers/prune:\n post:\n summary: \"Delete stopped containers\"\n produces:\n - \"application/json\"\n operationId: \"ContainerPrune\"\n parameters:\n - name: \"filters\"\n in: \"query\"\n description: |\n Filters to process on the prune list, encoded as JSON (a `map[string][]string`).\n\n Available filters:\n - `until=` Prune containers created before this timestamp. The `` can be Unix timestamps, date formatted timestamps, or Go duration strings (e.g. `10m`, `1h30m`) computed relative to the daemon machine’s time.\n - `label` (`label=`, `label==`, `label!=`, or `label!==`) Prune containers with (or without, in case `label!=...` is used) the specified labels.\n type: \"string\"\n responses:\n 200:\n description: \"No error\"\n schema:\n type: \"object\"\n title: \"ContainerPruneResponse\"\n properties:\n ContainersDeleted:\n description: \"Container IDs that were deleted\"\n type: \"array\"\n items:\n type: \"string\"\n SpaceReclaimed:\n description: \"Disk space reclaimed in bytes\"\n type: \"integer\"\n format: \"int64\"\n 500:\n description: \"Server error\"\n schema:\n $ref: \"#/definitions/ErrorResponse\"\n tags: [\"Container\"]\n /images/json:\n get:\n summary: \"List Images\"\n description: \"Returns a list of images on the server. Note that it uses a different, smaller representation of an image than inspecting a single image.\"\n operationId: \"ImageList\"\n produces:\n - \"application/json\"\n responses:\n 200:\n description: \"Summary image data for the images matching the query\"\n schema:\n type: \"array\"\n items:\n $ref: \"#/definitions/ImageSummary\"\n examples:\n application/json:\n - Id: \"sha256:e216a057b1cb1efc11f8a268f37ef62083e70b1b38323ba252e25ac88904a7e8\"\n ParentId: \"\"\n RepoTags:\n - \"ubuntu:12.04\"\n - \"ubuntu:precise\"\n RepoDigests:\n - \"ubuntu@sha256:992069aee4016783df6345315302fa59681aae51a8eeb2f889dea59290f21787\"\n Created: 1474925151\n Size: 103579269\n VirtualSize: 103579269\n SharedSize: 0\n Labels: {}\n Containers: 2\n - Id: \"sha256:3e314f95dcace0f5e4fd37b10862fe8398e3c60ed36600bc0ca5fda78b087175\"\n ParentId: \"\"\n RepoTags:\n - \"ubuntu:12.10\"\n - \"ubuntu:quantal\"\n RepoDigests:\n - \"ubuntu@sha256:002fba3e3255af10be97ea26e476692a7ebed0bb074a9ab960b2e7a1526b15d7\"\n - \"ubuntu@sha256:68ea0200f0b90df725d99d823905b04cf844f6039ef60c60bf3e019915017bd3\"\n Created: 1403128455\n Size: 172064416\n VirtualSize: 172064416\n SharedSize: 0\n Labels: {}\n Containers: 5\n 500:\n description: \"server error\"\n schema:\n $ref: \"#/definitions/ErrorResponse\"\n parameters:\n - name: \"all\"\n in: \"query\"\n description: \"Show all images. Only images from a final layer (no children) are shown by default.\"\n type: \"boolean\"\n default: false\n - name: \"filters\"\n in: \"query\"\n description: |\n A JSON encoded value of the filters (a `map[string][]string`) to\n process on the images list.\n\n Available filters:\n\n - `before`=(`[:]`, `` or ``)\n - `dangling=true`\n - `label=key` or `label=\"key=value\"` of an image label\n - `reference`=(`[:]`)\n - `since`=(`[:]`, `` or ``)\n type: \"string\"\n - name: \"shared-size\"\n in: \"query\"\n description: \"Compute and show shared size as a `SharedSize` field on each image.\"\n type: \"boolean\"\n default: false\n - name: \"digests\"\n in: \"query\"\n description: \"Show digest information as a `RepoDigests` field on each image.\"\n type: \"boolean\"\n default: false\n tags: [\"Image\"]\n /build:\n post:\n summary: \"Build an image\"\n description: |\n Build an image from a tar archive with a `Dockerfile` in it.\n\n The `Dockerfile` specifies how the image is built from the tar archive. It is typically in the archive's root, but can be at a different path or have a different name by specifying the `dockerfile` parameter. [See the `Dockerfile` reference for more information](https://docs.docker.com/engine/reference/builder/).\n\n The Docker daemon performs a preliminary validation of the `Dockerfile` before starting the build, and returns an error if the syntax is incorrect. After that, each instruction is run one-by-one until the ID of the new image is output.\n\n The build is canceled if the client drops the connection by quitting or being killed.\n operationId: \"ImageBuild\"\n consumes:\n - \"application/octet-stream\"\n produces:\n - \"application/json\"\n parameters:\n - name: \"inputStream\"\n in: \"body\"\n description: \"A tar archive compressed with one of the following algorithms: identity (no compression), gzip, bzip2, xz.\"\n schema:\n type: \"string\"\n format: \"binary\"\n - name: \"dockerfile\"\n in: \"query\"\n description: \"Path within the build context to the `Dockerfile`. This is ignored if `remote` is specified and points to an external `Dockerfile`.\"\n type: \"string\"\n default: \"Dockerfile\"\n - name: \"t\"\n in: \"query\"\n description: \"A name and optional tag to apply to the image in the `name:tag` format. If you omit the tag the default `latest` value is assumed. You can provide several `t` parameters.\"\n type: \"string\"\n - name: \"extrahosts\"\n in: \"query\"\n description: \"Extra hosts to add to /etc/hosts\"\n type: \"string\"\n - name: \"remote\"\n in: \"query\"\n description: \"A Git repository URI or HTTP/HTTPS context URI. If the URI points to a single text file, the file’s contents are placed into a file called `Dockerfile` and the image is built from that file. If the URI points to a tarball, the file is downloaded by the daemon and the contents therein used as the context for the build. If the URI points to a tarball and the `dockerfile` parameter is also specified, there must be a file with the corresponding path inside the tarball.\"\n type: \"string\"\n - name: \"q\"\n in: \"query\"\n description: \"Suppress verbose build output.\"\n type: \"boolean\"\n default: false\n - name: \"nocache\"\n in: \"query\"\n description: \"Do not use the cache when building the image.\"\n type: \"boolean\"\n default: false\n - name: \"cachefrom\"\n in: \"query\"\n description: \"JSON array of images used for build cache resolution.\"\n type: \"string\"\n - name: \"pull\"\n in: \"query\"\n description: \"Attempt to pull the image even if an older image exists locally.\"\n type: \"string\"\n - name: \"rm\"\n in: \"query\"\n description: \"Remove intermediate containers after a successful build.\"\n type: \"boolean\"\n default: true\n - name: \"forcerm\"\n in: \"query\"\n description: \"Always remove intermediate containers, even upon failure.\"\n type: \"boolean\"\n default: false\n - name: \"memory\"\n in: \"query\"\n description: \"Set memory limit for build.\"\n type: \"integer\"\n - name: \"memswap\"\n in: \"query\"\n description: \"Total memory (memory + swap). Set as `-1` to disable swap.\"\n type: \"integer\"\n - name: \"cpushares\"\n in: \"query\"\n description: \"CPU shares (relative weight).\"\n type: \"integer\"\n - name: \"cpusetcpus\"\n in: \"query\"\n description: \"CPUs in which to allow execution (e.g., `0-3`, `0,1`).\"\n type: \"string\"\n - name: \"cpuperiod\"\n in: \"query\"\n description: \"The length of a CPU period in microseconds.\"\n type: \"integer\"\n - name: \"cpuquota\"\n in: \"query\"\n description: \"Microseconds of CPU time that the container can get in a CPU period.\"\n type: \"integer\"\n - name: \"buildargs\"\n in: \"query\"\n description: >\n JSON map of string pairs for build-time variables. Users pass these values at build-time. Docker\n uses the buildargs as the environment context for commands run via the `Dockerfile` RUN\n instruction, or for variable expansion in other `Dockerfile` instructions. This is not meant for\n passing secret values.\n\n\n For example, the build arg `FOO=bar` would become `{\"FOO\":\"bar\"}` in JSON. This would result in the\n query parameter `buildargs={\"FOO\":\"bar\"}`. Note that `{\"FOO\":\"bar\"}` should be URI component encoded.\n\n\n [Read more about the buildargs instruction.](https://docs.docker.com/engine/reference/builder/#arg)\n type: \"string\"\n - name: \"shmsize\"\n in: \"query\"\n description: \"Size of `/dev/shm` in bytes. The size must be greater than 0. If omitted the system uses 64MB.\"\n type: \"integer\"\n - name: \"squash\"\n in: \"query\"\n description: \"Squash the resulting images layers into a single layer. *(Experimental release only.)*\"\n type: \"boolean\"\n - name: \"labels\"\n in: \"query\"\n description: \"Arbitrary key/value labels to set on the image, as a JSON map of string pairs.\"\n type: \"string\"\n - name: \"networkmode\"\n in: \"query\"\n description: |\n Sets the networking mode for the run commands during build. Supported\n standard values are: `bridge`, `host`, `none`, and `container:`.\n Any other value is taken as a custom network's name or ID to which this\n container should connect to.\n type: \"string\"\n - name: \"Content-type\"\n in: \"header\"\n type: \"string\"\n enum:\n - \"application/x-tar\"\n default: \"application/x-tar\"\n - name: \"X-Registry-Config\"\n in: \"header\"\n description: |\n This is a base64-encoded JSON object with auth configurations for multiple registries that a build may refer to.\n\n The key is a registry URL, and the value is an auth configuration object, [as described in the authentication section](#section/Authentication). For example:\n\n ```\n {\n \"docker.example.com\": {\n \"username\": \"janedoe\",\n \"password\": \"hunter2\"\n },\n \"https://index.docker.io/v1/\": {\n \"username\": \"mobydock\",\n \"password\": \"conta1n3rize14\"\n }\n }\n ```\n\n Only the registry domain name (and port if not the default 443) are required. However, for legacy reasons, the Docker Hub registry must be specified with both a `https://` prefix and a `/v1/` suffix even though Docker will prefer to use the v2 registry API.\n type: \"string\"\n - name: \"platform\"\n in: \"query\"\n description: \"Platform in the format os[/arch[/variant]]\"\n type: \"string\"\n default: \"\"\n - name: \"target\"\n in: \"query\"\n description: \"Target build stage\"\n type: \"string\"\n default: \"\"\n - name: \"outputs\"\n in: \"query\"\n description: \"BuildKit output configuration\"\n type: \"string\"\n default: \"\"\n responses:\n 200:\n description: \"no error\"\n 400:\n description: \"Bad parameter\"\n schema:\n $ref: \"#/definitions/ErrorResponse\"\n 500:\n description: \"server error\"\n schema:\n $ref: \"#/definitions/ErrorResponse\"\n tags: [\"Image\"]\n /build/prune:\n post:\n summary: \"Delete builder cache\"\n produces:\n - \"application/json\"\n operationId: \"BuildPrune\"\n parameters:\n - name: \"keep-storage\"\n in: \"query\"\n description: \"Amount of disk space in bytes to keep for cache\"\n type: \"integer\"\n format: \"int64\"\n - name: \"all\"\n in: \"query\"\n type: \"boolean\"\n description: \"Remove all types of build cache\"\n - name: \"filters\"\n in: \"query\"\n type: \"string\"\n description: |\n A JSON encoded value of the filters (a `map[string][]string`) to\n process on the list of build cache objects.\n\n Available filters:\n\n - `until=`: duration relative to daemon's time, during which build cache was not used, in Go's duration format (e.g., '24h')\n - `id=`\n - `parent=`\n - `type=`\n - `description=`\n - `inuse`\n - `shared`\n - `private`\n responses:\n 200:\n description: \"No error\"\n schema:\n type: \"object\"\n title: \"BuildPruneResponse\"\n properties:\n CachesDeleted:\n type: \"array\"\n items:\n description: \"ID of build cache object\"\n type: \"string\"\n SpaceReclaimed:\n description: \"Disk space reclaimed in bytes\"\n type: \"integer\"\n format: \"int64\"\n 500:\n description: \"Server error\"\n schema:\n $ref: \"#/definitions/ErrorResponse\"\n tags: [\"Image\"]\n /images/create:\n post:\n summary: \"Create an image\"\n description: \"Create an image by either pulling it from a registry or importing it.\"\n operationId: \"ImageCreate\"\n consumes:\n - \"text/plain\"\n - \"application/octet-stream\"\n produces:\n - \"application/json\"\n responses:\n 200:\n description: \"no error\"\n 404:\n description: \"repository does not exist or no read access\"\n schema:\n $ref: \"#/definitions/ErrorResponse\"\n 500:\n description: \"server error\"\n schema:\n $ref: \"#/definitions/ErrorResponse\"\n parameters:\n - name: \"fromImage\"\n in: \"query\"\n description: \"Name of the image to pull. The name may include a tag or digest. This parameter may only be used when pulling an image. The pull is cancelled if the HTTP connection is closed.\"\n type: \"string\"\n - name: \"fromSrc\"\n in: \"query\"\n description: \"Source to import. The value may be a URL from which the image can be retrieved or `-` to read the image from the request body. This parameter may only be used when importing an image.\"\n type: \"string\"\n - name: \"repo\"\n in: \"query\"\n description: \"Repository name given to an image when it is imported. The repo may include a tag. This parameter may only be used when importing an image.\"\n type: \"string\"\n - name: \"tag\"\n in: \"query\"\n description: \"Tag or digest. If empty when pulling an image, this causes all tags for the given image to be pulled.\"\n type: \"string\"\n - name: \"message\"\n in: \"query\"\n description: \"Set commit message for imported image.\"\n type: \"string\"\n - name: \"inputImage\"\n in: \"body\"\n description: \"Image content if the value `-` has been specified in fromSrc query parameter\"\n schema:\n type: \"string\"\n required: false\n - name: \"X-Registry-Auth\"\n in: \"header\"\n description: |\n A base64url-encoded auth configuration.\n\n Refer to the [authentication section](#section/Authentication) for\n details.\n type: \"string\"\n - name: \"platform\"\n in: \"query\"\n description: \"Platform in the format os[/arch[/variant]]\"\n type: \"string\"\n default: \"\"\n tags: [\"Image\"]\n /images/{name}/json:\n get:\n summary: \"Inspect an image\"\n description: \"Return low-level information about an image.\"\n operationId: \"ImageInspect\"\n produces:\n - \"application/json\"\n responses:\n 200:\n description: \"No error\"\n schema:\n $ref: \"#/definitions/Image\"\n examples:\n application/json:\n Id: \"sha256:85f05633ddc1c50679be2b16a0479ab6f7637f8884e0cfe0f4d20e1ebb3d6e7c\"\n Container: \"cb91e48a60d01f1e27028b4fc6819f4f290b3cf12496c8176ec714d0d390984a\"\n Comment: \"\"\n Os: \"linux\"\n Architecture: \"amd64\"\n Parent: \"sha256:91e54dfb11794fad694460162bf0cb0a4fa710cfa3f60979c177d920813e267c\"\n ContainerConfig:\n Tty: false\n Hostname: \"e611e15f9c9d\"\n Domainname: \"\"\n AttachStdout: false\n PublishService: \"\"\n AttachStdin: false\n OpenStdin: false\n StdinOnce: false\n NetworkDisabled: false\n OnBuild: []\n Image: \"91e54dfb11794fad694460162bf0cb0a4fa710cfa3f60979c177d920813e267c\"\n User: \"\"\n WorkingDir: \"\"\n MacAddress: \"\"\n AttachStderr: false\n Labels:\n com.example.license: \"GPL\"\n com.example.version: \"1.0\"\n com.example.vendor: \"Acme\"\n Env:\n - \"PATH=/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin\"\n Cmd:\n - \"/bin/sh\"\n - \"-c\"\n - \"#(nop) LABEL com.example.vendor=Acme com.example.license=GPL com.example.version=1.0\"\n DockerVersion: \"1.9.0-dev\"\n VirtualSize: 188359297\n Size: 0\n Author: \"\"\n Created: \"2015-09-10T08:30:53.26995814Z\"\n GraphDriver:\n Name: \"aufs\"\n Data: {}\n RepoDigests:\n - \"localhost:5000/test/busybox/example@sha256:cbbf2f9a99b47fc460d422812b6a5adff7dfee951d8fa2e4a98caa0382cfbdbf\"\n RepoTags:\n - \"example:1.0\"\n - \"example:latest\"\n - \"example:stable\"\n Config:\n Image: \"91e54dfb11794fad694460162bf0cb0a4fa710cfa3f60979c177d920813e267c\"\n NetworkDisabled: false\n OnBuild: []\n StdinOnce: false\n PublishService: \"\"\n AttachStdin: false\n OpenStdin: false\n Domainname: \"\"\n AttachStdout: false\n Tty: false\n Hostname: \"e611e15f9c9d\"\n Cmd:\n - \"/bin/bash\"\n Env:\n - \"PATH=/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin\"\n Labels:\n com.example.vendor: \"Acme\"\n com.example.version: \"1.0\"\n com.example.license: \"GPL\"\n MacAddress: \"\"\n AttachStderr: false\n WorkingDir: \"\"\n User: \"\"\n RootFS:\n Type: \"layers\"\n Layers:\n - \"sha256:1834950e52ce4d5a88a1bbd131c537f4d0e56d10ff0dd69e66be3b7dfa9df7e6\"\n - \"sha256:5f70bf18a086007016e948b04aed3b82103a36bea41755b6cddfaf10ace3c6ef\"\n 404:\n description: \"No such image\"\n schema:\n $ref: \"#/definitions/ErrorResponse\"\n examples:\n application/json:\n message: \"No such image: someimage (tag: latest)\"\n 500:\n description: \"Server error\"\n schema:\n $ref: \"#/definitions/ErrorResponse\"\n parameters:\n - name: \"name\"\n in: \"path\"\n description: \"Image name or id\"\n type: \"string\"\n required: true\n tags: [\"Image\"]\n /images/{name}/history:\n get:\n summary: \"Get the history of an image\"\n description: \"Return parent layers of an image.\"\n operationId: \"ImageHistory\"\n produces: [\"application/json\"]\n responses:\n 200:\n description: \"List of image layers\"\n schema:\n type: \"array\"\n items:\n type: \"object\"\n x-go-name: HistoryResponseItem\n title: \"HistoryResponseItem\"\n description: \"individual image layer information in response to ImageHistory operation\"\n required: [Id, Created, CreatedBy, Tags, Size, Comment]\n properties:\n Id:\n type: \"string\"\n x-nullable: false\n Created:\n type: \"integer\"\n format: \"int64\"\n x-nullable: false\n CreatedBy:\n type: \"string\"\n x-nullable: false\n Tags:\n type: \"array\"\n items:\n type: \"string\"\n Size:\n type: \"integer\"\n format: \"int64\"\n x-nullable: false\n Comment:\n type: \"string\"\n x-nullable: false\n examples:\n application/json:\n - Id: \"3db9c44f45209632d6050b35958829c3a2aa256d81b9a7be45b362ff85c54710\"\n Created: 1398108230\n CreatedBy: \"/bin/sh -c #(nop) ADD file:eb15dbd63394e063b805a3c32ca7bf0266ef64676d5a6fab4801f2e81e2a5148 in /\"\n Tags:\n - \"ubuntu:lucid\"\n - \"ubuntu:10.04\"\n Size: 182964289\n Comment: \"\"\n - Id: \"6cfa4d1f33fb861d4d114f43b25abd0ac737509268065cdfd69d544a59c85ab8\"\n Created: 1398108222\n CreatedBy: \"/bin/sh -c #(nop) MAINTAINER Tianon Gravi - mkimage-debootstrap.sh -i iproute,iputils-ping,ubuntu-minimal -t lucid.tar.xz lucid http://archive.ubuntu.com/ubuntu/\"\n Tags: []\n Size: 0\n Comment: \"\"\n - Id: \"511136ea3c5a64f264b78b5433614aec563103b4d4702f3ba7d4d2698e22c158\"\n Created: 1371157430\n CreatedBy: \"\"\n Tags:\n - \"scratch12:latest\"\n - \"scratch:latest\"\n Size: 0\n Comment: \"Imported from -\"\n 404:\n description: \"No such image\"\n schema:\n $ref: \"#/definitions/ErrorResponse\"\n 500:\n description: \"Server error\"\n schema:\n $ref: \"#/definitions/ErrorResponse\"\n parameters:\n - name: \"name\"\n in: \"path\"\n description: \"Image name or ID\"\n type: \"string\"\n required: true\n tags: [\"Image\"]\n /images/{name}/push:\n post:\n summary: \"Push an image\"\n description: |\n Push an image to a registry.\n\n If you wish to push an image on to a private registry, that image must\n already have a tag which references the registry. For example,\n `registry.example.com/myimage:latest`.\n\n The push is cancelled if the HTTP connection is closed.\n operationId: \"ImagePush\"\n consumes:\n - \"application/octet-stream\"\n responses:\n 200:\n description: \"No error\"\n 404:\n description: \"No such image\"\n schema:\n $ref: \"#/definitions/ErrorResponse\"\n 500:\n description: \"Server error\"\n schema:\n $ref: \"#/definitions/ErrorResponse\"\n parameters:\n - name: \"name\"\n in: \"path\"\n description: \"Image name or ID.\"\n type: \"string\"\n required: true\n - name: \"tag\"\n in: \"query\"\n description: \"The tag to associate with the image on the registry.\"\n type: \"string\"\n - name: \"X-Registry-Auth\"\n in: \"header\"\n description: |\n A base64url-encoded auth configuration.\n\n Refer to the [authentication section](#section/Authentication) for\n details.\n type: \"string\"\n required: true\n tags: [\"Image\"]\n /images/{name}/tag:\n post:\n summary: \"Tag an image\"\n description: \"Tag an image so that it becomes part of a repository.\"\n operationId: \"ImageTag\"\n responses:\n 201:\n description: \"No error\"\n 400:\n description: \"Bad parameter\"\n schema:\n $ref: \"#/definitions/ErrorResponse\"\n 404:\n description: \"No such image\"\n schema:\n $ref: \"#/definitions/ErrorResponse\"\n 409:\n description: \"Conflict\"\n schema:\n $ref: \"#/definitions/ErrorResponse\"\n 500:\n description: \"Server error\"\n schema:\n $ref: \"#/definitions/ErrorResponse\"\n parameters:\n - name: \"name\"\n in: \"path\"\n description: \"Image name or ID to tag.\"\n type: \"string\"\n required: true\n - name: \"repo\"\n in: \"query\"\n description: \"The repository to tag in. For example, `someuser/someimage`.\"\n type: \"string\"\n - name: \"tag\"\n in: \"query\"\n description: \"The name of the new tag.\"\n type: \"string\"\n tags: [\"Image\"]\n /images/{name}:\n delete:\n summary: \"Remove an image\"\n description: |\n Remove an image, along with any untagged parent images that were\n referenced by that image.\n\n Images can't be removed if they have descendant images, are being\n used by a running container or are being used by a build.\n operationId: \"ImageDelete\"\n produces: [\"application/json\"]\n responses:\n 200:\n description: \"The image was deleted successfully\"\n schema:\n type: \"array\"\n items:\n $ref: \"#/definitions/ImageDeleteResponseItem\"\n examples:\n application/json:\n - Untagged: \"3e2f21a89f\"\n - Deleted: \"3e2f21a89f\"\n - Deleted: \"53b4f83ac9\"\n 404:\n description: \"No such image\"\n schema:\n $ref: \"#/definitions/ErrorResponse\"\n 409:\n description: \"Conflict\"\n schema:\n $ref: \"#/definitions/ErrorResponse\"\n 500:\n description: \"Server error\"\n schema:\n $ref: \"#/definitions/ErrorResponse\"\n parameters:\n - name: \"name\"\n in: \"path\"\n description: \"Image name or ID\"\n type: \"string\"\n required: true\n - name: \"force\"\n in: \"query\"\n description: \"Remove the image even if it is being used by stopped containers or has other tags\"\n type: \"boolean\"\n default: false\n - name: \"noprune\"\n in: \"query\"\n description: \"Do not delete untagged parent images\"\n type: \"boolean\"\n default: false\n tags: [\"Image\"]\n /images/search:\n get:\n summary: \"Search images\"\n description: \"Search for an image on Docker Hub.\"\n operationId: \"ImageSearch\"\n produces:\n - \"application/json\"\n responses:\n 200:\n description: \"No error\"\n schema:\n type: \"array\"\n items:\n type: \"object\"\n title: \"ImageSearchResponseItem\"\n properties:\n description:\n type: \"string\"\n is_official:\n type: \"boolean\"\n is_automated:\n type: \"boolean\"\n name:\n type: \"string\"\n star_count:\n type: \"integer\"\n examples:\n application/json:\n - description: \"\"\n is_official: false\n is_automated: false\n name: \"wma55/u1210sshd\"\n star_count: 0\n - description: \"\"\n is_official: false\n is_automated: false\n name: \"jdswinbank/sshd\"\n star_count: 0\n - description: \"\"\n is_official: false\n is_automated: false\n name: \"vgauthier/sshd\"\n star_count: 0\n 500:\n description: \"Server error\"\n schema:\n $ref: \"#/definitions/ErrorResponse\"\n parameters:\n - name: \"term\"\n in: \"query\"\n description: \"Term to search\"\n type: \"string\"\n required: true\n - name: \"limit\"\n in: \"query\"\n description: \"Maximum number of results to return\"\n type: \"integer\"\n - name: \"filters\"\n in: \"query\"\n description: |\n A JSON encoded value of the filters (a `map[string][]string`) to process on the images list. Available filters:\n\n - `is-automated=(true|false)`\n - `is-official=(true|false)`\n - `stars=` Matches images that has at least 'number' stars.\n type: \"string\"\n tags: [\"Image\"]\n /images/prune:\n post:\n summary: \"Delete unused images\"\n produces:\n - \"application/json\"\n operationId: \"ImagePrune\"\n parameters:\n - name: \"filters\"\n in: \"query\"\n description: |\n Filters to process on the prune list, encoded as JSON (a `map[string][]string`). Available filters:\n\n - `dangling=` When set to `true` (or `1`), prune only\n unused *and* untagged images. When set to `false`\n (or `0`), all unused images are pruned.\n - `until=` Prune images created before this timestamp. The `` can be Unix timestamps, date formatted timestamps, or Go duration strings (e.g. `10m`, `1h30m`) computed relative to the daemon machine’s time.\n - `label` (`label=`, `label==`, `label!=`, or `label!==`) Prune images with (or without, in case `label!=...` is used) the specified labels.\n type: \"string\"\n responses:\n 200:\n description: \"No error\"\n schema:\n type: \"object\"\n title: \"ImagePruneResponse\"\n properties:\n ImagesDeleted:\n description: \"Images that were deleted\"\n type: \"array\"\n items:\n $ref: \"#/definitions/ImageDeleteResponseItem\"\n SpaceReclaimed:\n description: \"Disk space reclaimed in bytes\"\n type: \"integer\"\n format: \"int64\"\n 500:\n description: \"Server error\"\n schema:\n $ref: \"#/definitions/ErrorResponse\"\n tags: [\"Image\"]\n /auth:\n post:\n summary: \"Check auth configuration\"\n description: |\n Validate credentials for a registry and, if available, get an identity\n token for accessing the registry without password.\n operationId: \"SystemAuth\"\n consumes: [\"application/json\"]\n produces: [\"application/json\"]\n responses:\n 200:\n description: \"An identity token was generated successfully.\"\n schema:\n type: \"object\"\n title: \"SystemAuthResponse\"\n required: [Status]\n properties:\n Status:\n description: \"The status of the authentication\"\n type: \"string\"\n x-nullable: false\n IdentityToken:\n description: \"An opaque token used to authenticate a user after a successful login\"\n type: \"string\"\n x-nullable: false\n examples:\n application/json:\n Status: \"Login Succeeded\"\n IdentityToken: \"9cbaf023786cd7...\"\n 204:\n description: \"No error\"\n 500:\n description: \"Server error\"\n schema:\n $ref: \"#/definitions/ErrorResponse\"\n parameters:\n - name: \"authConfig\"\n in: \"body\"\n description: \"Authentication to check\"\n schema:\n $ref: \"#/definitions/AuthConfig\"\n tags: [\"System\"]\n /info:\n get:\n summary: \"Get system information\"\n operationId: \"SystemInfo\"\n produces:\n - \"application/json\"\n responses:\n 200:\n description: \"No error\"\n schema:\n $ref: \"#/definitions/SystemInfo\"\n 500:\n description: \"Server error\"\n schema:\n $ref: \"#/definitions/ErrorResponse\"\n tags: [\"System\"]\n /version:\n get:\n summary: \"Get version\"\n description: \"Returns the version of Docker that is running and various information about the system that Docker is running on.\"\n operationId: \"SystemVersion\"\n produces: [\"application/json\"]\n responses:\n 200:\n description: \"no error\"\n schema:\n $ref: \"#/definitions/SystemVersion\"\n 500:\n description: \"server error\"\n schema:\n $ref: \"#/definitions/ErrorResponse\"\n tags: [\"System\"]\n /_ping:\n get:\n summary: \"Ping\"\n description: \"This is a dummy endpoint you can use to test if the server is accessible.\"\n operationId: \"SystemPing\"\n produces: [\"text/plain\"]\n responses:\n 200:\n description: \"no error\"\n schema:\n type: \"string\"\n example: \"OK\"\n headers:\n API-Version:\n type: \"string\"\n description: \"Max API Version the server supports\"\n Builder-Version:\n type: \"string\"\n description: \"Default version of docker image builder\"\n Docker-Experimental:\n type: \"boolean\"\n description: \"If the server is running with experimental mode enabled\"\n Cache-Control:\n type: \"string\"\n default: \"no-cache, no-store, must-revalidate\"\n Pragma:\n type: \"string\"\n default: \"no-cache\"\n 500:\n description: \"server error\"\n schema:\n $ref: \"#/definitions/ErrorResponse\"\n headers:\n Cache-Control:\n type: \"string\"\n default: \"no-cache, no-store, must-revalidate\"\n Pragma:\n type: \"string\"\n default: \"no-cache\"\n tags: [\"System\"]\n head:\n summary: \"Ping\"\n description: \"This is a dummy endpoint you can use to test if the server is accessible.\"\n operationId: \"SystemPingHead\"\n produces: [\"text/plain\"]\n responses:\n 200:\n description: \"no error\"\n schema:\n type: \"string\"\n example: \"(empty)\"\n headers:\n API-Version:\n type: \"string\"\n description: \"Max API Version the server supports\"\n Builder-Version:\n type: \"string\"\n description: \"Default version of docker image builder\"\n Docker-Experimental:\n type: \"boolean\"\n description: \"If the server is running with experimental mode enabled\"\n Cache-Control:\n type: \"string\"\n default: \"no-cache, no-store, must-revalidate\"\n Pragma:\n type: \"string\"\n default: \"no-cache\"\n 500:\n description: \"server error\"\n schema:\n $ref: \"#/definitions/ErrorResponse\"\n tags: [\"System\"]\n /commit:\n post:\n summary: \"Create a new image from a container\"\n operationId: \"ImageCommit\"\n consumes:\n - \"application/json\"\n produces:\n - \"application/json\"\n responses:\n 201:\n description: \"no error\"\n schema:\n $ref: \"#/definitions/IdResponse\"\n 404:\n description: \"no such container\"\n schema:\n $ref: \"#/definitions/ErrorResponse\"\n examples:\n application/json:\n message: \"No such container: c2ada9df5af8\"\n 500:\n description: \"server error\"\n schema:\n $ref: \"#/definitions/ErrorResponse\"\n parameters:\n - name: \"containerConfig\"\n in: \"body\"\n description: \"The container configuration\"\n schema:\n $ref: \"#/definitions/ContainerConfig\"\n - name: \"container\"\n in: \"query\"\n description: \"The ID or name of the container to commit\"\n type: \"string\"\n - name: \"repo\"\n in: \"query\"\n description: \"Repository name for the created image\"\n type: \"string\"\n - name: \"tag\"\n in: \"query\"\n description: \"Tag name for the create image\"\n type: \"string\"\n - name: \"comment\"\n in: \"query\"\n description: \"Commit message\"\n type: \"string\"\n - name: \"author\"\n in: \"query\"\n description: \"Author of the image (e.g., `John Hannibal Smith `)\"\n type: \"string\"\n - name: \"pause\"\n in: \"query\"\n description: \"Whether to pause the container before committing\"\n type: \"boolean\"\n default: true\n - name: \"changes\"\n in: \"query\"\n description: \"`Dockerfile` instructions to apply while committing\"\n type: \"string\"\n tags: [\"Image\"]\n /events:\n get:\n summary: \"Monitor events\"\n description: |\n Stream real-time events from the server.\n\n Various objects within Docker report events when something happens to them.\n\n Containers report these events: `attach`, `commit`, `copy`, `create`, `destroy`, `detach`, `die`, `exec_create`, `exec_detach`, `exec_start`, `exec_die`, `export`, `health_status`, `kill`, `oom`, `pause`, `rename`, `resize`, `restart`, `start`, `stop`, `top`, `unpause`, `update`, and `prune`\n\n Images report these events: `delete`, `import`, `load`, `pull`, `push`, `save`, `tag`, `untag`, and `prune`\n\n Volumes report these events: `create`, `mount`, `unmount`, `destroy`, and `prune`\n\n Networks report these events: `create`, `connect`, `disconnect`, `destroy`, `update`, `remove`, and `prune`\n\n The Docker daemon reports these events: `reload`\n\n Services report these events: `create`, `update`, and `remove`\n\n Nodes report these events: `create`, `update`, and `remove`\n\n Secrets report these events: `create`, `update`, and `remove`\n\n Configs report these events: `create`, `update`, and `remove`\n\n The Builder reports `prune` events\n\n operationId: \"SystemEvents\"\n produces:\n - \"application/json\"\n responses:\n 200:\n description: \"no error\"\n schema:\n type: \"object\"\n title: \"SystemEventsResponse\"\n properties:\n Type:\n description: \"The type of object emitting the event\"\n type: \"string\"\n Action:\n description: \"The type of event\"\n type: \"string\"\n Actor:\n type: \"object\"\n properties:\n ID:\n description: \"The ID of the object emitting the event\"\n type: \"string\"\n Attributes:\n description: \"Various key/value attributes of the object, depending on its type\"\n type: \"object\"\n additionalProperties:\n type: \"string\"\n time:\n description: \"Timestamp of event\"\n type: \"integer\"\n timeNano:\n description: \"Timestamp of event, with nanosecond accuracy\"\n type: \"integer\"\n format: \"int64\"\n examples:\n application/json:\n Type: \"container\"\n Action: \"create\"\n Actor:\n ID: \"ede54ee1afda366ab42f824e8a5ffd195155d853ceaec74a927f249ea270c743\"\n Attributes:\n com.example.some-label: \"some-label-value\"\n image: \"alpine\"\n name: \"my-container\"\n time: 1461943101\n 400:\n description: \"bad parameter\"\n schema:\n $ref: \"#/definitions/ErrorResponse\"\n 500:\n description: \"server error\"\n schema:\n $ref: \"#/definitions/ErrorResponse\"\n parameters:\n - name: \"since\"\n in: \"query\"\n description: \"Show events created since this timestamp then stream new events.\"\n type: \"string\"\n - name: \"until\"\n in: \"query\"\n description: \"Show events created until this timestamp then stop streaming.\"\n type: \"string\"\n - name: \"filters\"\n in: \"query\"\n description: |\n A JSON encoded value of filters (a `map[string][]string`) to process on the event list. Available filters:\n\n - `config=` config name or ID\n - `container=` container name or ID\n - `daemon=` daemon name or ID\n - `event=` event type\n - `image=` image name or ID\n - `label=` image or container label\n - `network=` network name or ID\n - `node=` node ID\n - `plugin`= plugin name or ID\n - `scope`= local or swarm\n - `secret=` secret name or ID\n - `service=` service name or ID\n - `type=` object to filter by, one of `container`, `image`, `volume`, `network`, `daemon`, `plugin`, `node`, `service`, `secret` or `config`\n - `volume=` volume name\n type: \"string\"\n tags: [\"System\"]\n /system/df:\n get:\n summary: \"Get data usage information\"\n operationId: \"SystemDataUsage\"\n responses:\n 200:\n description: \"no error\"\n schema:\n type: \"object\"\n title: \"SystemDataUsageResponse\"\n properties:\n LayersSize:\n type: \"integer\"\n format: \"int64\"\n Images:\n type: \"array\"\n items:\n $ref: \"#/definitions/ImageSummary\"\n Containers:\n type: \"array\"\n items:\n $ref: \"#/definitions/ContainerSummary\"\n Volumes:\n type: \"array\"\n items:\n $ref: \"#/definitions/Volume\"\n BuildCache:\n type: \"array\"\n items:\n $ref: \"#/definitions/BuildCache\"\n example:\n LayersSize: 1092588\n Images:\n -\n Id: \"sha256:2b8fd9751c4c0f5dd266fcae00707e67a2545ef34f9a29354585f93dac906749\"\n ParentId: \"\"\n RepoTags:\n - \"busybox:latest\"\n RepoDigests:\n - \"busybox@sha256:a59906e33509d14c036c8678d687bd4eec81ed7c4b8ce907b888c607f6a1e0e6\"\n Created: 1466724217\n Size: 1092588\n SharedSize: 0\n VirtualSize: 1092588\n Labels: {}\n Containers: 1\n Containers:\n -\n Id: \"e575172ed11dc01bfce087fb27bee502db149e1a0fad7c296ad300bbff178148\"\n Names:\n - \"/top\"\n Image: \"busybox\"\n ImageID: \"sha256:2b8fd9751c4c0f5dd266fcae00707e67a2545ef34f9a29354585f93dac906749\"\n Command: \"top\"\n Created: 1472592424\n Ports: []\n SizeRootFs: 1092588\n Labels: {}\n State: \"exited\"\n Status: \"Exited (0) 56 minutes ago\"\n HostConfig:\n NetworkMode: \"default\"\n NetworkSettings:\n Networks:\n bridge:\n IPAMConfig: null\n Links: null\n Aliases: null\n NetworkID: \"d687bc59335f0e5c9ee8193e5612e8aee000c8c62ea170cfb99c098f95899d92\"\n EndpointID: \"8ed5115aeaad9abb174f68dcf135b49f11daf597678315231a32ca28441dec6a\"\n Gateway: \"172.18.0.1\"\n IPAddress: \"172.18.0.2\"\n IPPrefixLen: 16\n IPv6Gateway: \"\"\n GlobalIPv6Address: \"\"\n GlobalIPv6PrefixLen: 0\n MacAddress: \"02:42:ac:12:00:02\"\n Mounts: []\n Volumes:\n -\n Name: \"my-volume\"\n Driver: \"local\"\n Mountpoint: \"/var/lib/docker/volumes/my-volume/_data\"\n Labels: null\n Scope: \"local\"\n Options: null\n UsageData:\n Size: 10920104\n RefCount: 2\n BuildCache:\n -\n ID: \"hw53o5aio51xtltp5xjp8v7fx\"\n Parent: \"\"\n Type: \"regular\"\n Description: \"pulled from docker.io/library/debian@sha256:234cb88d3020898631af0ccbbcca9a66ae7306ecd30c9720690858c1b007d2a0\"\n InUse: false\n Shared: true\n Size: 0\n CreatedAt: \"2021-06-28T13:31:01.474619385Z\"\n LastUsedAt: \"2021-07-07T22:02:32.738075951Z\"\n UsageCount: 26\n -\n ID: \"ndlpt0hhvkqcdfkputsk4cq9c\"\n Parent: \"hw53o5aio51xtltp5xjp8v7fx\"\n Type: \"regular\"\n Description: \"mount / from exec /bin/sh -c echo 'Binary::apt::APT::Keep-Downloaded-Packages \\\"true\\\";' > /etc/apt/apt.conf.d/keep-cache\"\n InUse: false\n Shared: true\n Size: 51\n CreatedAt: \"2021-06-28T13:31:03.002625487Z\"\n LastUsedAt: \"2021-07-07T22:02:32.773909517Z\"\n UsageCount: 26\n 500:\n description: \"server error\"\n schema:\n $ref: \"#/definitions/ErrorResponse\"\n parameters:\n - name: \"type\"\n in: \"query\"\n description: |\n Object types, for which to compute and return data.\n type: \"array\"\n collectionFormat: multi\n items:\n type: \"string\"\n enum: [\"container\", \"image\", \"volume\", \"build-cache\"]\n tags: [\"System\"]\n /images/{name}/get:\n get:\n summary: \"Export an image\"\n description: |\n Get a tarball containing all images and metadata for a repository.\n\n If `name` is a specific name and tag (e.g. `ubuntu:latest`), then only that image (and its parents) are returned. If `name` is an image ID, similarly only that image (and its parents) are returned, but with the exclusion of the `repositories` file in the tarball, as there were no image names referenced.\n\n ### Image tarball format\n\n An image tarball contains one directory per image layer (named using its long ID), each containing these files:\n\n - `VERSION`: currently `1.0` - the file format version\n - `json`: detailed layer information, similar to `docker inspect layer_id`\n - `layer.tar`: A tarfile containing the filesystem changes in this layer\n\n The `layer.tar` file contains `aufs` style `.wh..wh.aufs` files and directories for storing attribute changes and deletions.\n\n If the tarball defines a repository, the tarball should also include a `repositories` file at the root that contains a list of repository and tag names mapped to layer IDs.\n\n ```json\n {\n \"hello-world\": {\n \"latest\": \"565a9d68a73f6706862bfe8409a7f659776d4d60a8d096eb4a3cbce6999cc2a1\"\n }\n }\n ```\n operationId: \"ImageGet\"\n produces:\n - \"application/x-tar\"\n responses:\n 200:\n description: \"no error\"\n schema:\n type: \"string\"\n format: \"binary\"\n 500:\n description: \"server error\"\n schema:\n $ref: \"#/definitions/ErrorResponse\"\n parameters:\n - name: \"name\"\n in: \"path\"\n description: \"Image name or ID\"\n type: \"string\"\n required: true\n tags: [\"Image\"]\n /images/get:\n get:\n summary: \"Export several images\"\n description: |\n Get a tarball containing all images and metadata for several image\n repositories.\n\n For each value of the `names` parameter: if it is a specific name and\n tag (e.g. `ubuntu:latest`), then only that image (and its parents) are\n returned; if it is an image ID, similarly only that image (and its parents)\n are returned and there would be no names referenced in the 'repositories'\n file for this image ID.\n\n For details on the format, see the [export image endpoint](#operation/ImageGet).\n operationId: \"ImageGetAll\"\n produces:\n - \"application/x-tar\"\n responses:\n 200:\n description: \"no error\"\n schema:\n type: \"string\"\n format: \"binary\"\n 500:\n description: \"server error\"\n schema:\n $ref: \"#/definitions/ErrorResponse\"\n parameters:\n - name: \"names\"\n in: \"query\"\n description: \"Image names to filter by\"\n type: \"array\"\n items:\n type: \"string\"\n tags: [\"Image\"]\n /images/load:\n post:\n summary: \"Import images\"\n description: |\n Load a set of images and tags into a repository.\n\n For details on the format, see the [export image endpoint](#operation/ImageGet).\n operationId: \"ImageLoad\"\n consumes:\n - \"application/x-tar\"\n produces:\n - \"application/json\"\n responses:\n 200:\n description: \"no error\"\n 500:\n description: \"server error\"\n schema:\n $ref: \"#/definitions/ErrorResponse\"\n parameters:\n - name: \"imagesTarball\"\n in: \"body\"\n description: \"Tar archive containing images\"\n schema:\n type: \"string\"\n format: \"binary\"\n - name: \"quiet\"\n in: \"query\"\n description: \"Suppress progress details during load.\"\n type: \"boolean\"\n default: false\n tags: [\"Image\"]\n /containers/{id}/exec:\n post:\n summary: \"Create an exec instance\"\n description: \"Run a command inside a running container.\"\n operationId: \"ContainerExec\"\n consumes:\n - \"application/json\"\n produces:\n - \"application/json\"\n responses:\n 201:\n description: \"no error\"\n schema:\n $ref: \"#/definitions/IdResponse\"\n 404:\n description: \"no such container\"\n schema:\n $ref: \"#/definitions/ErrorResponse\"\n examples:\n application/json:\n message: \"No such container: c2ada9df5af8\"\n 409:\n description: \"container is paused\"\n schema:\n $ref: \"#/definitions/ErrorResponse\"\n 500:\n description: \"Server error\"\n schema:\n $ref: \"#/definitions/ErrorResponse\"\n parameters:\n - name: \"execConfig\"\n in: \"body\"\n description: \"Exec configuration\"\n schema:\n type: \"object\"\n properties:\n AttachStdin:\n type: \"boolean\"\n description: \"Attach to `stdin` of the exec command.\"\n AttachStdout:\n type: \"boolean\"\n description: \"Attach to `stdout` of the exec command.\"\n AttachStderr:\n type: \"boolean\"\n description: \"Attach to `stderr` of the exec command.\"\n DetachKeys:\n type: \"string\"\n description: |\n Override the key sequence for detaching a container. Format is\n a single character `[a-Z]` or `ctrl-` where ``\n is one of: `a-z`, `@`, `^`, `[`, `,` or `_`.\n Tty:\n type: \"boolean\"\n description: \"Allocate a pseudo-TTY.\"\n Env:\n description: |\n A list of environment variables in the form `[\"VAR=value\", ...]`.\n type: \"array\"\n items:\n type: \"string\"\n Cmd:\n type: \"array\"\n description: \"Command to run, as a string or array of strings.\"\n items:\n type: \"string\"\n Privileged:\n type: \"boolean\"\n description: \"Runs the exec process with extended privileges.\"\n default: false\n User:\n type: \"string\"\n description: |\n The user, and optionally, group to run the exec process inside\n the container. Format is one of: `user`, `user:group`, `uid`,\n or `uid:gid`.\n WorkingDir:\n type: \"string\"\n description: |\n The working directory for the exec process inside the container.\n example:\n AttachStdin: false\n AttachStdout: true\n AttachStderr: true\n DetachKeys: \"ctrl-p,ctrl-q\"\n Tty: false\n Cmd:\n - \"date\"\n Env:\n - \"FOO=bar\"\n - \"BAZ=quux\"\n required: true\n - name: \"id\"\n in: \"path\"\n description: \"ID or name of container\"\n type: \"string\"\n required: true\n tags: [\"Exec\"]\n /exec/{id}/start:\n post:\n summary: \"Start an exec instance\"\n description: |\n Starts a previously set up exec instance. If detach is true, this endpoint\n returns immediately after starting the command. Otherwise, it sets up an\n interactive session with the command.\n operationId: \"ExecStart\"\n consumes:\n - \"application/json\"\n produces:\n - \"application/vnd.docker.raw-stream\"\n responses:\n 200:\n description: \"No error\"\n 404:\n description: \"No such exec instance\"\n schema:\n $ref: \"#/definitions/ErrorResponse\"\n 409:\n description: \"Container is stopped or paused\"\n schema:\n $ref: \"#/definitions/ErrorResponse\"\n parameters:\n - name: \"execStartConfig\"\n in: \"body\"\n schema:\n type: \"object\"\n properties:\n Detach:\n type: \"boolean\"\n description: \"Detach from the command.\"\n Tty:\n type: \"boolean\"\n description: \"Allocate a pseudo-TTY.\"\n example:\n Detach: false\n Tty: false\n - name: \"id\"\n in: \"path\"\n description: \"Exec instance ID\"\n required: true\n type: \"string\"\n tags: [\"Exec\"]\n /exec/{id}/resize:\n post:\n summary: \"Resize an exec instance\"\n description: |\n Resize the TTY session used by an exec instance. This endpoint only works\n if `tty` was specified as part of creating and starting the exec instance.\n operationId: \"ExecResize\"\n responses:\n 201:\n description: \"No error\"\n 404:\n description: \"No such exec instance\"\n schema:\n $ref: \"#/definitions/ErrorResponse\"\n parameters:\n - name: \"id\"\n in: \"path\"\n description: \"Exec instance ID\"\n required: true\n type: \"string\"\n - name: \"h\"\n in: \"query\"\n description: \"Height of the TTY session in characters\"\n type: \"integer\"\n - name: \"w\"\n in: \"query\"\n description: \"Width of the TTY session in characters\"\n type: \"integer\"\n tags: [\"Exec\"]\n /exec/{id}/json:\n get:\n summary: \"Inspect an exec instance\"\n description: \"Return low-level information about an exec instance.\"\n operationId: \"ExecInspect\"\n produces:\n - \"application/json\"\n responses:\n 200:\n description: \"No error\"\n schema:\n type: \"object\"\n title: \"ExecInspectResponse\"\n properties:\n CanRemove:\n type: \"boolean\"\n DetachKeys:\n type: \"string\"\n ID:\n type: \"string\"\n Running:\n type: \"boolean\"\n ExitCode:\n type: \"integer\"\n ProcessConfig:\n $ref: \"#/definitions/ProcessConfig\"\n OpenStdin:\n type: \"boolean\"\n OpenStderr:\n type: \"boolean\"\n OpenStdout:\n type: \"boolean\"\n ContainerID:\n type: \"string\"\n Pid:\n type: \"integer\"\n description: \"The system process ID for the exec process.\"\n examples:\n application/json:\n CanRemove: false\n ContainerID: \"b53ee82b53a40c7dca428523e34f741f3abc51d9f297a14ff874bf761b995126\"\n DetachKeys: \"\"\n ExitCode: 2\n ID: \"f33bbfb39f5b142420f4759b2348913bd4a8d1a6d7fd56499cb41a1bb91d7b3b\"\n OpenStderr: true\n OpenStdin: true\n OpenStdout: true\n ProcessConfig:\n arguments:\n - \"-c\"\n - \"exit 2\"\n entrypoint: \"sh\"\n privileged: false\n tty: true\n user: \"1000\"\n Running: false\n Pid: 42000\n 404:\n description: \"No such exec instance\"\n schema:\n $ref: \"#/definitions/ErrorResponse\"\n 500:\n description: \"Server error\"\n schema:\n $ref: \"#/definitions/ErrorResponse\"\n parameters:\n - name: \"id\"\n in: \"path\"\n description: \"Exec instance ID\"\n required: true\n type: \"string\"\n tags: [\"Exec\"]\n\n /volumes:\n get:\n summary: \"List volumes\"\n operationId: \"VolumeList\"\n produces: [\"application/json\"]\n responses:\n 200:\n description: \"Summary volume data that matches the query\"\n schema:\n type: \"object\"\n title: \"VolumeListResponse\"\n description: \"Volume list response\"\n required: [Volumes, Warnings]\n properties:\n Volumes:\n type: \"array\"\n x-nullable: false\n description: \"List of volumes\"\n items:\n $ref: \"#/definitions/Volume\"\n Warnings:\n type: \"array\"\n x-nullable: false\n description: |\n Warnings that occurred when fetching the list of volumes.\n items:\n type: \"string\"\n\n examples:\n application/json:\n Volumes:\n - CreatedAt: \"2017-07-19T12:00:26Z\"\n Name: \"tardis\"\n Driver: \"local\"\n Mountpoint: \"/var/lib/docker/volumes/tardis\"\n Labels:\n com.example.some-label: \"some-value\"\n com.example.some-other-label: \"some-other-value\"\n Scope: \"local\"\n Options:\n device: \"tmpfs\"\n o: \"size=100m,uid=1000\"\n type: \"tmpfs\"\n Warnings: []\n 500:\n description: \"Server error\"\n schema:\n $ref: \"#/definitions/ErrorResponse\"\n parameters:\n - name: \"filters\"\n in: \"query\"\n description: |\n JSON encoded value of the filters (a `map[string][]string`) to\n process on the volumes list. Available filters:\n\n - `dangling=` When set to `true` (or `1`), returns all\n volumes that are not in use by a container. When set to `false`\n (or `0`), only volumes that are in use by one or more\n containers are returned.\n - `driver=` Matches volumes based on their driver.\n - `label=` or `label=:` Matches volumes based on\n the presence of a `label` alone or a `label` and a value.\n - `name=` Matches all or part of a volume name.\n type: \"string\"\n format: \"json\"\n tags: [\"Volume\"]\n\n /volumes/create:\n post:\n summary: \"Create a volume\"\n operationId: \"VolumeCreate\"\n consumes: [\"application/json\"]\n produces: [\"application/json\"]\n responses:\n 201:\n description: \"The volume was created successfully\"\n schema:\n $ref: \"#/definitions/Volume\"\n 500:\n description: \"Server error\"\n schema:\n $ref: \"#/definitions/ErrorResponse\"\n parameters:\n - name: \"volumeConfig\"\n in: \"body\"\n required: true\n description: \"Volume configuration\"\n schema:\n type: \"object\"\n description: \"Volume configuration\"\n title: \"VolumeConfig\"\n properties:\n Name:\n description: |\n The new volume's name. If not specified, Docker generates a name.\n type: \"string\"\n x-nullable: false\n Driver:\n description: \"Name of the volume driver to use.\"\n type: \"string\"\n default: \"local\"\n x-nullable: false\n DriverOpts:\n description: |\n A mapping of driver options and values. These options are\n passed directly to the driver and are driver specific.\n type: \"object\"\n additionalProperties:\n type: \"string\"\n Labels:\n description: \"User-defined key/value metadata.\"\n type: \"object\"\n additionalProperties:\n type: \"string\"\n example:\n Name: \"tardis\"\n Labels:\n com.example.some-label: \"some-value\"\n com.example.some-other-label: \"some-other-value\"\n Driver: \"custom\"\n tags: [\"Volume\"]\n\n /volumes/{name}:\n get:\n summary: \"Inspect a volume\"\n operationId: \"VolumeInspect\"\n produces: [\"application/json\"]\n responses:\n 200:\n description: \"No error\"\n schema:\n $ref: \"#/definitions/Volume\"\n 404:\n description: \"No such volume\"\n schema:\n $ref: \"#/definitions/ErrorResponse\"\n 500:\n description: \"Server error\"\n schema:\n $ref: \"#/definitions/ErrorResponse\"\n parameters:\n - name: \"name\"\n in: \"path\"\n required: true\n description: \"Volume name or ID\"\n type: \"string\"\n tags: [\"Volume\"]\n\n delete:\n summary: \"Remove a volume\"\n description: \"Instruct the driver to remove the volume.\"\n operationId: \"VolumeDelete\"\n responses:\n 204:\n description: \"The volume was removed\"\n 404:\n description: \"No such volume or volume driver\"\n schema:\n $ref: \"#/definitions/ErrorResponse\"\n 409:\n description: \"Volume is in use and cannot be removed\"\n schema:\n $ref: \"#/definitions/ErrorResponse\"\n 500:\n description: \"Server error\"\n schema:\n $ref: \"#/definitions/ErrorResponse\"\n parameters:\n - name: \"name\"\n in: \"path\"\n required: true\n description: \"Volume name or ID\"\n type: \"string\"\n - name: \"force\"\n in: \"query\"\n description: \"Force the removal of the volume\"\n type: \"boolean\"\n default: false\n tags: [\"Volume\"]\n /volumes/prune:\n post:\n summary: \"Delete unused volumes\"\n produces:\n - \"application/json\"\n operationId: \"VolumePrune\"\n parameters:\n - name: \"filters\"\n in: \"query\"\n description: |\n Filters to process on the prune list, encoded as JSON (a `map[string][]string`).\n\n Available filters:\n - `label` (`label=`, `label==`, `label!=`, or `label!==`) Prune volumes with (or without, in case `label!=...` is used) the specified labels.\n type: \"string\"\n responses:\n 200:\n description: \"No error\"\n schema:\n type: \"object\"\n title: \"VolumePruneResponse\"\n properties:\n VolumesDeleted:\n description: \"Volumes that were deleted\"\n type: \"array\"\n items:\n type: \"string\"\n SpaceReclaimed:\n description: \"Disk space reclaimed in bytes\"\n type: \"integer\"\n format: \"int64\"\n 500:\n description: \"Server error\"\n schema:\n $ref: \"#/definitions/ErrorResponse\"\n tags: [\"Volume\"]\n /networks:\n get:\n summary: \"List networks\"\n description: |\n Returns a list of networks. For details on the format, see the\n [network inspect endpoint](#operation/NetworkInspect).\n\n Note that it uses a different, smaller representation of a network than\n inspecting a single network. For example, the list of containers attached\n to the network is not propagated in API versions 1.28 and up.\n operationId: \"NetworkList\"\n produces:\n - \"application/json\"\n responses:\n 200:\n description: \"No error\"\n schema:\n type: \"array\"\n items:\n $ref: \"#/definitions/Network\"\n examples:\n application/json:\n - Name: \"bridge\"\n Id: \"f2de39df4171b0dc801e8002d1d999b77256983dfc63041c0f34030aa3977566\"\n Created: \"2016-10-19T06:21:00.416543526Z\"\n Scope: \"local\"\n Driver: \"bridge\"\n EnableIPv6: false\n Internal: false\n Attachable: false\n Ingress: false\n IPAM:\n Driver: \"default\"\n Config:\n -\n Subnet: \"172.17.0.0/16\"\n Options:\n com.docker.network.bridge.default_bridge: \"true\"\n com.docker.network.bridge.enable_icc: \"true\"\n com.docker.network.bridge.enable_ip_masquerade: \"true\"\n com.docker.network.bridge.host_binding_ipv4: \"0.0.0.0\"\n com.docker.network.bridge.name: \"docker0\"\n com.docker.network.driver.mtu: \"1500\"\n - Name: \"none\"\n Id: \"e086a3893b05ab69242d3c44e49483a3bbbd3a26b46baa8f61ab797c1088d794\"\n Created: \"0001-01-01T00:00:00Z\"\n Scope: \"local\"\n Driver: \"null\"\n EnableIPv6: false\n Internal: false\n Attachable: false\n Ingress: false\n IPAM:\n Driver: \"default\"\n Config: []\n Containers: {}\n Options: {}\n - Name: \"host\"\n Id: \"13e871235c677f196c4e1ecebb9dc733b9b2d2ab589e30c539efeda84a24215e\"\n Created: \"0001-01-01T00:00:00Z\"\n Scope: \"local\"\n Driver: \"host\"\n EnableIPv6: false\n Internal: false\n Attachable: false\n Ingress: false\n IPAM:\n Driver: \"default\"\n Config: []\n Containers: {}\n Options: {}\n 500:\n description: \"Server error\"\n schema:\n $ref: \"#/definitions/ErrorResponse\"\n parameters:\n - name: \"filters\"\n in: \"query\"\n description: |\n JSON encoded value of the filters (a `map[string][]string`) to process\n on the networks list.\n\n Available filters:\n\n - `dangling=` When set to `true` (or `1`), returns all\n networks that are not in use by a container. When set to `false`\n (or `0`), only networks that are in use by one or more\n containers are returned.\n - `driver=` Matches a network's driver.\n - `id=` Matches all or part of a network ID.\n - `label=` or `label==` of a network label.\n - `name=` Matches all or part of a network name.\n - `scope=[\"swarm\"|\"global\"|\"local\"]` Filters networks by scope (`swarm`, `global`, or `local`).\n - `type=[\"custom\"|\"builtin\"]` Filters networks by type. The `custom` keyword returns all user-defined networks.\n type: \"string\"\n tags: [\"Network\"]\n\n /networks/{id}:\n get:\n summary: \"Inspect a network\"\n operationId: \"NetworkInspect\"\n produces:\n - \"application/json\"\n responses:\n 200:\n description: \"No error\"\n schema:\n $ref: \"#/definitions/Network\"\n 404:\n description: \"Network not found\"\n schema:\n $ref: \"#/definitions/ErrorResponse\"\n 500:\n description: \"Server error\"\n schema:\n $ref: \"#/definitions/ErrorResponse\"\n parameters:\n - name: \"id\"\n in: \"path\"\n description: \"Network ID or name\"\n required: true\n type: \"string\"\n - name: \"verbose\"\n in: \"query\"\n description: \"Detailed inspect output for troubleshooting\"\n type: \"boolean\"\n default: false\n - name: \"scope\"\n in: \"query\"\n description: \"Filter the network by scope (swarm, global, or local)\"\n type: \"string\"\n tags: [\"Network\"]\n\n delete:\n summary: \"Remove a network\"\n operationId: \"NetworkDelete\"\n responses:\n 204:\n description: \"No error\"\n 403:\n description: \"operation not supported for pre-defined networks\"\n schema:\n $ref: \"#/definitions/ErrorResponse\"\n 404:\n description: \"no such network\"\n schema:\n $ref: \"#/definitions/ErrorResponse\"\n 500:\n description: \"Server error\"\n schema:\n $ref: \"#/definitions/ErrorResponse\"\n parameters:\n - name: \"id\"\n in: \"path\"\n description: \"Network ID or name\"\n required: true\n type: \"string\"\n tags: [\"Network\"]\n\n /networks/create:\n post:\n summary: \"Create a network\"\n operationId: \"NetworkCreate\"\n consumes:\n - \"application/json\"\n produces:\n - \"application/json\"\n responses:\n 201:\n description: \"No error\"\n schema:\n type: \"object\"\n title: \"NetworkCreateResponse\"\n properties:\n Id:\n description: \"The ID of the created network.\"\n type: \"string\"\n Warning:\n type: \"string\"\n example:\n Id: \"22be93d5babb089c5aab8dbc369042fad48ff791584ca2da2100db837a1c7c30\"\n Warning: \"\"\n 403:\n description: \"operation not supported for pre-defined networks\"\n schema:\n $ref: \"#/definitions/ErrorResponse\"\n 404:\n description: \"plugin not found\"\n schema:\n $ref: \"#/definitions/ErrorResponse\"\n 500:\n description: \"Server error\"\n schema:\n $ref: \"#/definitions/ErrorResponse\"\n parameters:\n - name: \"networkConfig\"\n in: \"body\"\n description: \"Network configuration\"\n required: true\n schema:\n type: \"object\"\n required: [\"Name\"]\n properties:\n Name:\n description: \"The network's name.\"\n type: \"string\"\n CheckDuplicate:\n description: |\n Check for networks with duplicate names. Since Network is\n primarily keyed based on a random ID and not on the name, and\n network name is strictly a user-friendly alias to the network\n which is uniquely identified using ID, there is no guaranteed\n way to check for duplicates. CheckDuplicate is there to provide\n a best effort checking of any networks which has the same name\n but it is not guaranteed to catch all name collisions.\n type: \"boolean\"\n Driver:\n description: \"Name of the network driver plugin to use.\"\n type: \"string\"\n default: \"bridge\"\n Internal:\n description: \"Restrict external access to the network.\"\n type: \"boolean\"\n Attachable:\n description: |\n Globally scoped network is manually attachable by regular\n containers from workers in swarm mode.\n type: \"boolean\"\n Ingress:\n description: |\n Ingress network is the network which provides the routing-mesh\n in swarm mode.\n type: \"boolean\"\n IPAM:\n description: \"Optional custom IP scheme for the network.\"\n $ref: \"#/definitions/IPAM\"\n EnableIPv6:\n description: \"Enable IPv6 on the network.\"\n type: \"boolean\"\n Options:\n description: \"Network specific options to be used by the drivers.\"\n type: \"object\"\n additionalProperties:\n type: \"string\"\n Labels:\n description: \"User-defined key/value metadata.\"\n type: \"object\"\n additionalProperties:\n type: \"string\"\n example:\n Name: \"isolated_nw\"\n CheckDuplicate: false\n Driver: \"bridge\"\n EnableIPv6: true\n IPAM:\n Driver: \"default\"\n Config:\n - Subnet: \"172.20.0.0/16\"\n IPRange: \"172.20.10.0/24\"\n Gateway: \"172.20.10.11\"\n - Subnet: \"2001:db8:abcd::/64\"\n Gateway: \"2001:db8:abcd::1011\"\n Options:\n foo: \"bar\"\n Internal: true\n Attachable: false\n Ingress: false\n Options:\n com.docker.network.bridge.default_bridge: \"true\"\n com.docker.network.bridge.enable_icc: \"true\"\n com.docker.network.bridge.enable_ip_masquerade: \"true\"\n com.docker.network.bridge.host_binding_ipv4: \"0.0.0.0\"\n com.docker.network.bridge.name: \"docker0\"\n com.docker.network.driver.mtu: \"1500\"\n Labels:\n com.example.some-label: \"some-value\"\n com.example.some-other-label: \"some-other-value\"\n tags: [\"Network\"]\n\n /networks/{id}/connect:\n post:\n summary: \"Connect a container to a network\"\n operationId: \"NetworkConnect\"\n consumes:\n - \"application/json\"\n responses:\n 200:\n description: \"No error\"\n 403:\n description: \"Operation not supported for swarm scoped networks\"\n schema:\n $ref: \"#/definitions/ErrorResponse\"\n 404:\n description: \"Network or container not found\"\n schema:\n $ref: \"#/definitions/ErrorResponse\"\n 500:\n description: \"Server error\"\n schema:\n $ref: \"#/definitions/ErrorResponse\"\n parameters:\n - name: \"id\"\n in: \"path\"\n description: \"Network ID or name\"\n required: true\n type: \"string\"\n - name: \"container\"\n in: \"body\"\n required: true\n schema:\n type: \"object\"\n properties:\n Container:\n type: \"string\"\n description: \"The ID or name of the container to connect to the network.\"\n EndpointConfig:\n $ref: \"#/definitions/EndpointSettings\"\n example:\n Container: \"3613f73ba0e4\"\n EndpointConfig:\n IPAMConfig:\n IPv4Address: \"172.24.56.89\"\n IPv6Address: \"2001:db8::5689\"\n tags: [\"Network\"]\n\n /networks/{id}/disconnect:\n post:\n summary: \"Disconnect a container from a network\"\n operationId: \"NetworkDisconnect\"\n consumes:\n - \"application/json\"\n responses:\n 200:\n description: \"No error\"\n 403:\n description: \"Operation not supported for swarm scoped networks\"\n schema:\n $ref: \"#/definitions/ErrorResponse\"\n 404:\n description: \"Network or container not found\"\n schema:\n $ref: \"#/definitions/ErrorResponse\"\n 500:\n description: \"Server error\"\n schema:\n $ref: \"#/definitions/ErrorResponse\"\n parameters:\n - name: \"id\"\n in: \"path\"\n description: \"Network ID or name\"\n required: true\n type: \"string\"\n - name: \"container\"\n in: \"body\"\n required: true\n schema:\n type: \"object\"\n properties:\n Container:\n type: \"string\"\n description: |\n The ID or name of the container to disconnect from the network.\n Force:\n type: \"boolean\"\n description: |\n Force the container to disconnect from the network.\n tags: [\"Network\"]\n /networks/prune:\n post:\n summary: \"Delete unused networks\"\n produces:\n - \"application/json\"\n operationId: \"NetworkPrune\"\n parameters:\n - name: \"filters\"\n in: \"query\"\n description: |\n Filters to process on the prune list, encoded as JSON (a `map[string][]string`).\n\n Available filters:\n - `until=` Prune networks created before this timestamp. The `` can be Unix timestamps, date formatted timestamps, or Go duration strings (e.g. `10m`, `1h30m`) computed relative to the daemon machine’s time.\n - `label` (`label=`, `label==`, `label!=`, or `label!==`) Prune networks with (or without, in case `label!=...` is used) the specified labels.\n type: \"string\"\n responses:\n 200:\n description: \"No error\"\n schema:\n type: \"object\"\n title: \"NetworkPruneResponse\"\n properties:\n NetworksDeleted:\n description: \"Networks that were deleted\"\n type: \"array\"\n items:\n type: \"string\"\n 500:\n description: \"Server error\"\n schema:\n $ref: \"#/definitions/ErrorResponse\"\n tags: [\"Network\"]\n /plugins:\n get:\n summary: \"List plugins\"\n operationId: \"PluginList\"\n description: \"Returns information about installed plugins.\"\n produces: [\"application/json\"]\n responses:\n 200:\n description: \"No error\"\n schema:\n type: \"array\"\n items:\n $ref: \"#/definitions/Plugin\"\n 500:\n description: \"Server error\"\n schema:\n $ref: \"#/definitions/ErrorResponse\"\n parameters:\n - name: \"filters\"\n in: \"query\"\n type: \"string\"\n description: |\n A JSON encoded value of the filters (a `map[string][]string`) to\n process on the plugin list.\n\n Available filters:\n\n - `capability=`\n - `enable=|`\n tags: [\"Plugin\"]\n\n /plugins/privileges:\n get:\n summary: \"Get plugin privileges\"\n operationId: \"GetPluginPrivileges\"\n responses:\n 200:\n description: \"no error\"\n schema:\n type: \"array\"\n items:\n description: |\n Describes a permission the user has to accept upon installing\n the plugin.\n type: \"object\"\n title: \"PluginPrivilegeItem\"\n properties:\n Name:\n type: \"string\"\n Description:\n type: \"string\"\n Value:\n type: \"array\"\n items:\n type: \"string\"\n example:\n - Name: \"network\"\n Description: \"\"\n Value:\n - \"host\"\n - Name: \"mount\"\n Description: \"\"\n Value:\n - \"/data\"\n - Name: \"device\"\n Description: \"\"\n Value:\n - \"/dev/cpu_dma_latency\"\n 500:\n description: \"server error\"\n schema:\n $ref: \"#/definitions/ErrorResponse\"\n parameters:\n - name: \"remote\"\n in: \"query\"\n description: |\n The name of the plugin. The `:latest` tag is optional, and is the\n default if omitted.\n required: true\n type: \"string\"\n tags:\n - \"Plugin\"\n\n /plugins/pull:\n post:\n summary: \"Install a plugin\"\n operationId: \"PluginPull\"\n description: |\n Pulls and installs a plugin. After the plugin is installed, it can be\n enabled using the [`POST /plugins/{name}/enable` endpoint](#operation/PostPluginsEnable).\n produces:\n - \"application/json\"\n responses:\n 204:\n description: \"no error\"\n 500:\n description: \"server error\"\n schema:\n $ref: \"#/definitions/ErrorResponse\"\n parameters:\n - name: \"remote\"\n in: \"query\"\n description: |\n Remote reference for plugin to install.\n\n The `:latest` tag is optional, and is used as the default if omitted.\n required: true\n type: \"string\"\n - name: \"name\"\n in: \"query\"\n description: |\n Local name for the pulled plugin.\n\n The `:latest` tag is optional, and is used as the default if omitted.\n required: false\n type: \"string\"\n - name: \"X-Registry-Auth\"\n in: \"header\"\n description: |\n A base64url-encoded auth configuration to use when pulling a plugin\n from a registry.\n\n Refer to the [authentication section](#section/Authentication) for\n details.\n type: \"string\"\n - name: \"body\"\n in: \"body\"\n schema:\n type: \"array\"\n items:\n description: |\n Describes a permission accepted by the user upon installing the\n plugin.\n type: \"object\"\n properties:\n Name:\n type: \"string\"\n Description:\n type: \"string\"\n Value:\n type: \"array\"\n items:\n type: \"string\"\n example:\n - Name: \"network\"\n Description: \"\"\n Value:\n - \"host\"\n - Name: \"mount\"\n Description: \"\"\n Value:\n - \"/data\"\n - Name: \"device\"\n Description: \"\"\n Value:\n - \"/dev/cpu_dma_latency\"\n tags: [\"Plugin\"]\n /plugins/{name}/json:\n get:\n summary: \"Inspect a plugin\"\n operationId: \"PluginInspect\"\n responses:\n 200:\n description: \"no error\"\n schema:\n $ref: \"#/definitions/Plugin\"\n 404:\n description: \"plugin is not installed\"\n schema:\n $ref: \"#/definitions/ErrorResponse\"\n 500:\n description: \"server error\"\n schema:\n $ref: \"#/definitions/ErrorResponse\"\n parameters:\n - name: \"name\"\n in: \"path\"\n description: |\n The name of the plugin. The `:latest` tag is optional, and is the\n default if omitted.\n required: true\n type: \"string\"\n tags: [\"Plugin\"]\n /plugins/{name}:\n delete:\n summary: \"Remove a plugin\"\n operationId: \"PluginDelete\"\n responses:\n 200:\n description: \"no error\"\n schema:\n $ref: \"#/definitions/Plugin\"\n 404:\n description: \"plugin is not installed\"\n schema:\n $ref: \"#/definitions/ErrorResponse\"\n 500:\n description: \"server error\"\n schema:\n $ref: \"#/definitions/ErrorResponse\"\n parameters:\n - name: \"name\"\n in: \"path\"\n description: |\n The name of the plugin. The `:latest` tag is optional, and is the\n default if omitted.\n required: true\n type: \"string\"\n - name: \"force\"\n in: \"query\"\n description: |\n Disable the plugin before removing. This may result in issues if the\n plugin is in use by a container.\n type: \"boolean\"\n default: false\n tags: [\"Plugin\"]\n /plugins/{name}/enable:\n post:\n summary: \"Enable a plugin\"\n operationId: \"PluginEnable\"\n responses:\n 200:\n description: \"no error\"\n 404:\n description: \"plugin is not installed\"\n schema:\n $ref: \"#/definitions/ErrorResponse\"\n 500:\n description: \"server error\"\n schema:\n $ref: \"#/definitions/ErrorResponse\"\n parameters:\n - name: \"name\"\n in: \"path\"\n description: |\n The name of the plugin. The `:latest` tag is optional, and is the\n default if omitted.\n required: true\n type: \"string\"\n - name: \"timeout\"\n in: \"query\"\n description: \"Set the HTTP client timeout (in seconds)\"\n type: \"integer\"\n default: 0\n tags: [\"Plugin\"]\n /plugins/{name}/disable:\n post:\n summary: \"Disable a plugin\"\n operationId: \"PluginDisable\"\n responses:\n 200:\n description: \"no error\"\n 404:\n description: \"plugin is not installed\"\n schema:\n $ref: \"#/definitions/ErrorResponse\"\n 500:\n description: \"server error\"\n schema:\n $ref: \"#/definitions/ErrorResponse\"\n parameters:\n - name: \"name\"\n in: \"path\"\n description: |\n The name of the plugin. The `:latest` tag is optional, and is the\n default if omitted.\n required: true\n type: \"string\"\n tags: [\"Plugin\"]\n /plugins/{name}/upgrade:\n post:\n summary: \"Upgrade a plugin\"\n operationId: \"PluginUpgrade\"\n responses:\n 204:\n description: \"no error\"\n 404:\n description: \"plugin not installed\"\n schema:\n $ref: \"#/definitions/ErrorResponse\"\n 500:\n description: \"server error\"\n schema:\n $ref: \"#/definitions/ErrorResponse\"\n parameters:\n - name: \"name\"\n in: \"path\"\n description: |\n The name of the plugin. The `:latest` tag is optional, and is the\n default if omitted.\n required: true\n type: \"string\"\n - name: \"remote\"\n in: \"query\"\n description: |\n Remote reference to upgrade to.\n\n The `:latest` tag is optional, and is used as the default if omitted.\n required: true\n type: \"string\"\n - name: \"X-Registry-Auth\"\n in: \"header\"\n description: |\n A base64url-encoded auth configuration to use when pulling a plugin\n from a registry.\n\n Refer to the [authentication section](#section/Authentication) for\n details.\n type: \"string\"\n - name: \"body\"\n in: \"body\"\n schema:\n type: \"array\"\n items:\n description: |\n Describes a permission accepted by the user upon installing the\n plugin.\n type: \"object\"\n properties:\n Name:\n type: \"string\"\n Description:\n type: \"string\"\n Value:\n type: \"array\"\n items:\n type: \"string\"\n example:\n - Name: \"network\"\n Description: \"\"\n Value:\n - \"host\"\n - Name: \"mount\"\n Description: \"\"\n Value:\n - \"/data\"\n - Name: \"device\"\n Description: \"\"\n Value:\n - \"/dev/cpu_dma_latency\"\n tags: [\"Plugin\"]\n /plugins/create:\n post:\n summary: \"Create a plugin\"\n operationId: \"PluginCreate\"\n consumes:\n - \"application/x-tar\"\n responses:\n 204:\n description: \"no error\"\n 500:\n description: \"server error\"\n schema:\n $ref: \"#/definitions/ErrorResponse\"\n parameters:\n - name: \"name\"\n in: \"query\"\n description: |\n The name of the plugin. The `:latest` tag is optional, and is the\n default if omitted.\n required: true\n type: \"string\"\n - name: \"tarContext\"\n in: \"body\"\n description: \"Path to tar containing plugin rootfs and manifest\"\n schema:\n type: \"string\"\n format: \"binary\"\n tags: [\"Plugin\"]\n /plugins/{name}/push:\n post:\n summary: \"Push a plugin\"\n operationId: \"PluginPush\"\n description: |\n Push a plugin to the registry.\n parameters:\n - name: \"name\"\n in: \"path\"\n description: |\n The name of the plugin. The `:latest` tag is optional, and is the\n default if omitted.\n required: true\n type: \"string\"\n responses:\n 200:\n description: \"no error\"\n 404:\n description: \"plugin not installed\"\n schema:\n $ref: \"#/definitions/ErrorResponse\"\n 500:\n description: \"server error\"\n schema:\n $ref: \"#/definitions/ErrorResponse\"\n tags: [\"Plugin\"]\n /plugins/{name}/set:\n post:\n summary: \"Configure a plugin\"\n operationId: \"PluginSet\"\n consumes:\n - \"application/json\"\n parameters:\n - name: \"name\"\n in: \"path\"\n description: |\n The name of the plugin. The `:latest` tag is optional, and is the\n default if omitted.\n required: true\n type: \"string\"\n - name: \"body\"\n in: \"body\"\n schema:\n type: \"array\"\n items:\n type: \"string\"\n example: [\"DEBUG=1\"]\n responses:\n 204:\n description: \"No error\"\n 404:\n description: \"Plugin not installed\"\n schema:\n $ref: \"#/definitions/ErrorResponse\"\n 500:\n description: \"Server error\"\n schema:\n $ref: \"#/definitions/ErrorResponse\"\n tags: [\"Plugin\"]\n /nodes:\n get:\n summary: \"List nodes\"\n operationId: \"NodeList\"\n responses:\n 200:\n description: \"no error\"\n schema:\n type: \"array\"\n items:\n $ref: \"#/definitions/Node\"\n 500:\n description: \"server error\"\n schema:\n $ref: \"#/definitions/ErrorResponse\"\n 503:\n description: \"node is not part of a swarm\"\n schema:\n $ref: \"#/definitions/ErrorResponse\"\n parameters:\n - name: \"filters\"\n in: \"query\"\n description: |\n Filters to process on the nodes list, encoded as JSON (a `map[string][]string`).\n\n Available filters:\n - `id=`\n - `label=`\n - `membership=`(`accepted`|`pending`)`\n - `name=`\n - `node.label=`\n - `role=`(`manager`|`worker`)`\n type: \"string\"\n tags: [\"Node\"]\n /nodes/{id}:\n get:\n summary: \"Inspect a node\"\n operationId: \"NodeInspect\"\n responses:\n 200:\n description: \"no error\"\n schema:\n $ref: \"#/definitions/Node\"\n 404:\n description: \"no such node\"\n schema:\n $ref: \"#/definitions/ErrorResponse\"\n 500:\n description: \"server error\"\n schema:\n $ref: \"#/definitions/ErrorResponse\"\n 503:\n description: \"node is not part of a swarm\"\n schema:\n $ref: \"#/definitions/ErrorResponse\"\n parameters:\n - name: \"id\"\n in: \"path\"\n description: \"The ID or name of the node\"\n type: \"string\"\n required: true\n tags: [\"Node\"]\n delete:\n summary: \"Delete a node\"\n operationId: \"NodeDelete\"\n responses:\n 200:\n description: \"no error\"\n 404:\n description: \"no such node\"\n schema:\n $ref: \"#/definitions/ErrorResponse\"\n 500:\n description: \"server error\"\n schema:\n $ref: \"#/definitions/ErrorResponse\"\n 503:\n description: \"node is not part of a swarm\"\n schema:\n $ref: \"#/definitions/ErrorResponse\"\n parameters:\n - name: \"id\"\n in: \"path\"\n description: \"The ID or name of the node\"\n type: \"string\"\n required: true\n - name: \"force\"\n in: \"query\"\n description: \"Force remove a node from the swarm\"\n default: false\n type: \"boolean\"\n tags: [\"Node\"]\n /nodes/{id}/update:\n post:\n summary: \"Update a node\"\n operationId: \"NodeUpdate\"\n responses:\n 200:\n description: \"no error\"\n 400:\n description: \"bad parameter\"\n schema:\n $ref: \"#/definitions/ErrorResponse\"\n 404:\n description: \"no such node\"\n schema:\n $ref: \"#/definitions/ErrorResponse\"\n 500:\n description: \"server error\"\n schema:\n $ref: \"#/definitions/ErrorResponse\"\n 503:\n description: \"node is not part of a swarm\"\n schema:\n $ref: \"#/definitions/ErrorResponse\"\n parameters:\n - name: \"id\"\n in: \"path\"\n description: \"The ID of the node\"\n type: \"string\"\n required: true\n - name: \"body\"\n in: \"body\"\n schema:\n $ref: \"#/definitions/NodeSpec\"\n - name: \"version\"\n in: \"query\"\n description: |\n The version number of the node object being updated. This is required\n to avoid conflicting writes.\n type: \"integer\"\n format: \"int64\"\n required: true\n tags: [\"Node\"]\n /swarm:\n get:\n summary: \"Inspect swarm\"\n operationId: \"SwarmInspect\"\n responses:\n 200:\n description: \"no error\"\n schema:\n $ref: \"#/definitions/Swarm\"\n 404:\n description: \"no such swarm\"\n schema:\n $ref: \"#/definitions/ErrorResponse\"\n 500:\n description: \"server error\"\n schema:\n $ref: \"#/definitions/ErrorResponse\"\n 503:\n description: \"node is not part of a swarm\"\n schema:\n $ref: \"#/definitions/ErrorResponse\"\n tags: [\"Swarm\"]\n /swarm/init:\n post:\n summary: \"Initialize a new swarm\"\n operationId: \"SwarmInit\"\n produces:\n - \"application/json\"\n - \"text/plain\"\n responses:\n 200:\n description: \"no error\"\n schema:\n description: \"The node ID\"\n type: \"string\"\n example: \"7v2t30z9blmxuhnyo6s4cpenp\"\n 400:\n description: \"bad parameter\"\n schema:\n $ref: \"#/definitions/ErrorResponse\"\n 500:\n description: \"server error\"\n schema:\n $ref: \"#/definitions/ErrorResponse\"\n 503:\n description: \"node is already part of a swarm\"\n schema:\n $ref: \"#/definitions/ErrorResponse\"\n parameters:\n - name: \"body\"\n in: \"body\"\n required: true\n schema:\n type: \"object\"\n properties:\n ListenAddr:\n description: |\n Listen address used for inter-manager communication, as well\n as determining the networking interface used for the VXLAN\n Tunnel Endpoint (VTEP). This can either be an address/port\n combination in the form `192.168.1.1:4567`, or an interface\n followed by a port number, like `eth0:4567`. If the port number\n is omitted, the default swarm listening port is used.\n type: \"string\"\n AdvertiseAddr:\n description: |\n Externally reachable address advertised to other nodes. This\n can either be an address/port combination in the form\n `192.168.1.1:4567`, or an interface followed by a port number,\n like `eth0:4567`. If the port number is omitted, the port\n number from the listen address is used. If `AdvertiseAddr` is\n not specified, it will be automatically detected when possible.\n type: \"string\"\n DataPathAddr:\n description: |\n Address or interface to use for data path traffic (format:\n ``), for example, `192.168.1.1`, or an interface,\n like `eth0`. If `DataPathAddr` is unspecified, the same address\n as `AdvertiseAddr` is used.\n\n The `DataPathAddr` specifies the address that global scope\n network drivers will publish towards other nodes in order to\n reach the containers running on this node. Using this parameter\n it is possible to separate the container data traffic from the\n management traffic of the cluster.\n type: \"string\"\n DataPathPort:\n description: |\n DataPathPort specifies the data path port number for data traffic.\n Acceptable port range is 1024 to 49151.\n if no port is set or is set to 0, default port 4789 will be used.\n type: \"integer\"\n format: \"uint32\"\n DefaultAddrPool:\n description: |\n Default Address Pool specifies default subnet pools for global\n scope networks.\n type: \"array\"\n items:\n type: \"string\"\n example: [\"10.10.0.0/16\", \"20.20.0.0/16\"]\n ForceNewCluster:\n description: \"Force creation of a new swarm.\"\n type: \"boolean\"\n SubnetSize:\n description: |\n SubnetSize specifies the subnet size of the networks created\n from the default subnet pool.\n type: \"integer\"\n format: \"uint32\"\n Spec:\n $ref: \"#/definitions/SwarmSpec\"\n example:\n ListenAddr: \"0.0.0.0:2377\"\n AdvertiseAddr: \"192.168.1.1:2377\"\n DataPathPort: 4789\n DefaultAddrPool: [\"10.10.0.0/8\", \"20.20.0.0/8\"]\n SubnetSize: 24\n ForceNewCluster: false\n Spec:\n Orchestration: {}\n Raft: {}\n Dispatcher: {}\n CAConfig: {}\n EncryptionConfig:\n AutoLockManagers: false\n tags: [\"Swarm\"]\n /swarm/join:\n post:\n summary: \"Join an existing swarm\"\n operationId: \"SwarmJoin\"\n responses:\n 200:\n description: \"no error\"\n 400:\n description: \"bad parameter\"\n schema:\n $ref: \"#/definitions/ErrorResponse\"\n 500:\n description: \"server error\"\n schema:\n $ref: \"#/definitions/ErrorResponse\"\n 503:\n description: \"node is already part of a swarm\"\n schema:\n $ref: \"#/definitions/ErrorResponse\"\n parameters:\n - name: \"body\"\n in: \"body\"\n required: true\n schema:\n type: \"object\"\n properties:\n ListenAddr:\n description: |\n Listen address used for inter-manager communication if the node\n gets promoted to manager, as well as determining the networking\n interface used for the VXLAN Tunnel Endpoint (VTEP).\n type: \"string\"\n AdvertiseAddr:\n description: |\n Externally reachable address advertised to other nodes. This\n can either be an address/port combination in the form\n `192.168.1.1:4567`, or an interface followed by a port number,\n like `eth0:4567`. If the port number is omitted, the port\n number from the listen address is used. If `AdvertiseAddr` is\n not specified, it will be automatically detected when possible.\n type: \"string\"\n DataPathAddr:\n description: |\n Address or interface to use for data path traffic (format:\n ``), for example, `192.168.1.1`, or an interface,\n like `eth0`. If `DataPathAddr` is unspecified, the same address\n as `AdvertiseAddr` is used.\n\n The `DataPathAddr` specifies the address that global scope\n network drivers will publish towards other nodes in order to\n reach the containers running on this node. Using this parameter\n it is possible to separate the container data traffic from the\n management traffic of the cluster.\n\n type: \"string\"\n RemoteAddrs:\n description: |\n Addresses of manager nodes already participating in the swarm.\n type: \"array\"\n items:\n type: \"string\"\n JoinToken:\n description: \"Secret token for joining this swarm.\"\n type: \"string\"\n example:\n ListenAddr: \"0.0.0.0:2377\"\n AdvertiseAddr: \"192.168.1.1:2377\"\n RemoteAddrs:\n - \"node1:2377\"\n JoinToken: \"SWMTKN-1-3pu6hszjas19xyp7ghgosyx9k8atbfcr8p2is99znpy26u2lkl-7p73s1dx5in4tatdymyhg9hu2\"\n tags: [\"Swarm\"]\n /swarm/leave:\n post:\n summary: \"Leave a swarm\"\n operationId: \"SwarmLeave\"\n responses:\n 200:\n description: \"no error\"\n 500:\n description: \"server error\"\n schema:\n $ref: \"#/definitions/ErrorResponse\"\n 503:\n description: \"node is not part of a swarm\"\n schema:\n $ref: \"#/definitions/ErrorResponse\"\n parameters:\n - name: \"force\"\n description: |\n Force leave swarm, even if this is the last manager or that it will\n break the cluster.\n in: \"query\"\n type: \"boolean\"\n default: false\n tags: [\"Swarm\"]\n /swarm/update:\n post:\n summary: \"Update a swarm\"\n operationId: \"SwarmUpdate\"\n responses:\n 200:\n description: \"no error\"\n 400:\n description: \"bad parameter\"\n schema:\n $ref: \"#/definitions/ErrorResponse\"\n 500:\n description: \"server error\"\n schema:\n $ref: \"#/definitions/ErrorResponse\"\n 503:\n description: \"node is not part of a swarm\"\n schema:\n $ref: \"#/definitions/ErrorResponse\"\n parameters:\n - name: \"body\"\n in: \"body\"\n required: true\n schema:\n $ref: \"#/definitions/SwarmSpec\"\n - name: \"version\"\n in: \"query\"\n description: |\n The version number of the swarm object being updated. This is\n required to avoid conflicting writes.\n type: \"integer\"\n format: \"int64\"\n required: true\n - name: \"rotateWorkerToken\"\n in: \"query\"\n description: \"Rotate the worker join token.\"\n type: \"boolean\"\n default: false\n - name: \"rotateManagerToken\"\n in: \"query\"\n description: \"Rotate the manager join token.\"\n type: \"boolean\"\n default: false\n - name: \"rotateManagerUnlockKey\"\n in: \"query\"\n description: \"Rotate the manager unlock key.\"\n type: \"boolean\"\n default: false\n tags: [\"Swarm\"]\n /swarm/unlockkey:\n get:\n summary: \"Get the unlock key\"\n operationId: \"SwarmUnlockkey\"\n consumes:\n - \"application/json\"\n responses:\n 200:\n description: \"no error\"\n schema:\n type: \"object\"\n title: \"UnlockKeyResponse\"\n properties:\n UnlockKey:\n description: \"The swarm's unlock key.\"\n type: \"string\"\n example:\n UnlockKey: \"SWMKEY-1-7c37Cc8654o6p38HnroywCi19pllOnGtbdZEgtKxZu8\"\n 500:\n description: \"server error\"\n schema:\n $ref: \"#/definitions/ErrorResponse\"\n 503:\n description: \"node is not part of a swarm\"\n schema:\n $ref: \"#/definitions/ErrorResponse\"\n tags: [\"Swarm\"]\n /swarm/unlock:\n post:\n summary: \"Unlock a locked manager\"\n operationId: \"SwarmUnlock\"\n consumes:\n - \"application/json\"\n produces:\n - \"application/json\"\n parameters:\n - name: \"body\"\n in: \"body\"\n required: true\n schema:\n type: \"object\"\n properties:\n UnlockKey:\n description: \"The swarm's unlock key.\"\n type: \"string\"\n example:\n UnlockKey: \"SWMKEY-1-7c37Cc8654o6p38HnroywCi19pllOnGtbdZEgtKxZu8\"\n responses:\n 200:\n description: \"no error\"\n 500:\n description: \"server error\"\n schema:\n $ref: \"#/definitions/ErrorResponse\"\n 503:\n description: \"node is not part of a swarm\"\n schema:\n $ref: \"#/definitions/ErrorResponse\"\n tags: [\"Swarm\"]\n /services:\n get:\n summary: \"List services\"\n operationId: \"ServiceList\"\n responses:\n 200:\n description: \"no error\"\n schema:\n type: \"array\"\n items:\n $ref: \"#/definitions/Service\"\n 500:\n description: \"server error\"\n schema:\n $ref: \"#/definitions/ErrorResponse\"\n 503:\n description: \"node is not part of a swarm\"\n schema:\n $ref: \"#/definitions/ErrorResponse\"\n parameters:\n - name: \"filters\"\n in: \"query\"\n type: \"string\"\n description: |\n A JSON encoded value of the filters (a `map[string][]string`) to\n process on the services list.\n\n Available filters:\n\n - `id=`\n - `label=`\n - `mode=[\"replicated\"|\"global\"]`\n - `name=`\n - name: \"status\"\n in: \"query\"\n type: \"boolean\"\n description: |\n Include service status, with count of running and desired tasks.\n tags: [\"Service\"]\n /services/create:\n post:\n summary: \"Create a service\"\n operationId: \"ServiceCreate\"\n consumes:\n - \"application/json\"\n produces:\n - \"application/json\"\n responses:\n 201:\n description: \"no error\"\n schema:\n type: \"object\"\n title: \"ServiceCreateResponse\"\n properties:\n ID:\n description: \"The ID of the created service.\"\n type: \"string\"\n Warning:\n description: \"Optional warning message\"\n type: \"string\"\n example:\n ID: \"ak7w3gjqoa3kuz8xcpnyy0pvl\"\n Warning: \"unable to pin image doesnotexist:latest to digest: image library/doesnotexist:latest not found\"\n 400:\n description: \"bad parameter\"\n schema:\n $ref: \"#/definitions/ErrorResponse\"\n 403:\n description: \"network is not eligible for services\"\n schema:\n $ref: \"#/definitions/ErrorResponse\"\n 409:\n description: \"name conflicts with an existing service\"\n schema:\n $ref: \"#/definitions/ErrorResponse\"\n 500:\n description: \"server error\"\n schema:\n $ref: \"#/definitions/ErrorResponse\"\n 503:\n description: \"node is not part of a swarm\"\n schema:\n $ref: \"#/definitions/ErrorResponse\"\n parameters:\n - name: \"body\"\n in: \"body\"\n required: true\n schema:\n allOf:\n - $ref: \"#/definitions/ServiceSpec\"\n - type: \"object\"\n example:\n Name: \"web\"\n TaskTemplate:\n ContainerSpec:\n Image: \"nginx:alpine\"\n Mounts:\n -\n ReadOnly: true\n Source: \"web-data\"\n Target: \"/usr/share/nginx/html\"\n Type: \"volume\"\n VolumeOptions:\n DriverConfig: {}\n Labels:\n com.example.something: \"something-value\"\n Hosts: [\"10.10.10.10 host1\", \"ABCD:EF01:2345:6789:ABCD:EF01:2345:6789 host2\"]\n User: \"33\"\n DNSConfig:\n Nameservers: [\"8.8.8.8\"]\n Search: [\"example.org\"]\n Options: [\"timeout:3\"]\n Secrets:\n -\n File:\n Name: \"www.example.org.key\"\n UID: \"33\"\n GID: \"33\"\n Mode: 384\n SecretID: \"fpjqlhnwb19zds35k8wn80lq9\"\n SecretName: \"example_org_domain_key\"\n LogDriver:\n Name: \"json-file\"\n Options:\n max-file: \"3\"\n max-size: \"10M\"\n Placement: {}\n Resources:\n Limits:\n MemoryBytes: 104857600\n Reservations: {}\n RestartPolicy:\n Condition: \"on-failure\"\n Delay: 10000000000\n MaxAttempts: 10\n Mode:\n Replicated:\n Replicas: 4\n UpdateConfig:\n Parallelism: 2\n Delay: 1000000000\n FailureAction: \"pause\"\n Monitor: 15000000000\n MaxFailureRatio: 0.15\n RollbackConfig:\n Parallelism: 1\n Delay: 1000000000\n FailureAction: \"pause\"\n Monitor: 15000000000\n MaxFailureRatio: 0.15\n EndpointSpec:\n Ports:\n -\n Protocol: \"tcp\"\n PublishedPort: 8080\n TargetPort: 80\n Labels:\n foo: \"bar\"\n - name: \"X-Registry-Auth\"\n in: \"header\"\n description: |\n A base64url-encoded auth configuration for pulling from private\n registries.\n\n Refer to the [authentication section](#section/Authentication) for\n details.\n type: \"string\"\n tags: [\"Service\"]\n /services/{id}:\n get:\n summary: \"Inspect a service\"\n operationId: \"ServiceInspect\"\n responses:\n 200:\n description: \"no error\"\n schema:\n $ref: \"#/definitions/Service\"\n 404:\n description: \"no such service\"\n schema:\n $ref: \"#/definitions/ErrorResponse\"\n 500:\n description: \"server error\"\n schema:\n $ref: \"#/definitions/ErrorResponse\"\n 503:\n description: \"node is not part of a swarm\"\n schema:\n $ref: \"#/definitions/ErrorResponse\"\n parameters:\n - name: \"id\"\n in: \"path\"\n description: \"ID or name of service.\"\n required: true\n type: \"string\"\n - name: \"insertDefaults\"\n in: \"query\"\n description: \"Fill empty fields with default values.\"\n type: \"boolean\"\n default: false\n tags: [\"Service\"]\n delete:\n summary: \"Delete a service\"\n operationId: \"ServiceDelete\"\n responses:\n 200:\n description: \"no error\"\n 404:\n description: \"no such service\"\n schema:\n $ref: \"#/definitions/ErrorResponse\"\n 500:\n description: \"server error\"\n schema:\n $ref: \"#/definitions/ErrorResponse\"\n 503:\n description: \"node is not part of a swarm\"\n schema:\n $ref: \"#/definitions/ErrorResponse\"\n parameters:\n - name: \"id\"\n in: \"path\"\n description: \"ID or name of service.\"\n required: true\n type: \"string\"\n tags: [\"Service\"]\n /services/{id}/update:\n post:\n summary: \"Update a service\"\n operationId: \"ServiceUpdate\"\n consumes: [\"application/json\"]\n produces: [\"application/json\"]\n responses:\n 200:\n description: \"no error\"\n schema:\n $ref: \"#/definitions/ServiceUpdateResponse\"\n 400:\n description: \"bad parameter\"\n schema:\n $ref: \"#/definitions/ErrorResponse\"\n 404:\n description: \"no such service\"\n schema:\n $ref: \"#/definitions/ErrorResponse\"\n 500:\n description: \"server error\"\n schema:\n $ref: \"#/definitions/ErrorResponse\"\n 503:\n description: \"node is not part of a swarm\"\n schema:\n $ref: \"#/definitions/ErrorResponse\"\n parameters:\n - name: \"id\"\n in: \"path\"\n description: \"ID or name of service.\"\n required: true\n type: \"string\"\n - name: \"body\"\n in: \"body\"\n required: true\n schema:\n allOf:\n - $ref: \"#/definitions/ServiceSpec\"\n - type: \"object\"\n example:\n Name: \"top\"\n TaskTemplate:\n ContainerSpec:\n Image: \"busybox\"\n Args:\n - \"top\"\n Resources:\n Limits: {}\n Reservations: {}\n RestartPolicy:\n Condition: \"any\"\n MaxAttempts: 0\n Placement: {}\n ForceUpdate: 0\n Mode:\n Replicated:\n Replicas: 1\n UpdateConfig:\n Parallelism: 2\n Delay: 1000000000\n FailureAction: \"pause\"\n Monitor: 15000000000\n MaxFailureRatio: 0.15\n RollbackConfig:\n Parallelism: 1\n Delay: 1000000000\n FailureAction: \"pause\"\n Monitor: 15000000000\n MaxFailureRatio: 0.15\n EndpointSpec:\n Mode: \"vip\"\n\n - name: \"version\"\n in: \"query\"\n description: |\n The version number of the service object being updated. This is\n required to avoid conflicting writes.\n This version number should be the value as currently set on the\n service *before* the update. You can find the current version by\n calling `GET /services/{id}`\n required: true\n type: \"integer\"\n - name: \"registryAuthFrom\"\n in: \"query\"\n description: |\n If the `X-Registry-Auth` header is not specified, this parameter\n indicates where to find registry authorization credentials.\n type: \"string\"\n enum: [\"spec\", \"previous-spec\"]\n default: \"spec\"\n - name: \"rollback\"\n in: \"query\"\n description: |\n Set to this parameter to `previous` to cause a server-side rollback\n to the previous service spec. The supplied spec will be ignored in\n this case.\n type: \"string\"\n - name: \"X-Registry-Auth\"\n in: \"header\"\n description: |\n A base64url-encoded auth configuration for pulling from private\n registries.\n\n Refer to the [authentication section](#section/Authentication) for\n details.\n type: \"string\"\n\n tags: [\"Service\"]\n /services/{id}/logs:\n get:\n summary: \"Get service logs\"\n description: |\n Get `stdout` and `stderr` logs from a service. See also\n [`/containers/{id}/logs`](#operation/ContainerLogs).\n\n **Note**: This endpoint works only for services with the `local`,\n `json-file` or `journald` logging drivers.\n operationId: \"ServiceLogs\"\n responses:\n 200:\n description: \"logs returned as a stream in response body\"\n schema:\n type: \"string\"\n format: \"binary\"\n 404:\n description: \"no such service\"\n schema:\n $ref: \"#/definitions/ErrorResponse\"\n examples:\n application/json:\n message: \"No such service: c2ada9df5af8\"\n 500:\n description: \"server error\"\n schema:\n $ref: \"#/definitions/ErrorResponse\"\n 503:\n description: \"node is not part of a swarm\"\n schema:\n $ref: \"#/definitions/ErrorResponse\"\n parameters:\n - name: \"id\"\n in: \"path\"\n required: true\n description: \"ID or name of the service\"\n type: \"string\"\n - name: \"details\"\n in: \"query\"\n description: \"Show service context and extra details provided to logs.\"\n type: \"boolean\"\n default: false\n - name: \"follow\"\n in: \"query\"\n description: \"Keep connection after returning logs.\"\n type: \"boolean\"\n default: false\n - name: \"stdout\"\n in: \"query\"\n description: \"Return logs from `stdout`\"\n type: \"boolean\"\n default: false\n - name: \"stderr\"\n in: \"query\"\n description: \"Return logs from `stderr`\"\n type: \"boolean\"\n default: false\n - name: \"since\"\n in: \"query\"\n description: \"Only return logs since this time, as a UNIX timestamp\"\n type: \"integer\"\n default: 0\n - name: \"timestamps\"\n in: \"query\"\n description: \"Add timestamps to every log line\"\n type: \"boolean\"\n default: false\n - name: \"tail\"\n in: \"query\"\n description: |\n Only return this number of log lines from the end of the logs.\n Specify as an integer or `all` to output all log lines.\n type: \"string\"\n default: \"all\"\n tags: [\"Service\"]\n /tasks:\n get:\n summary: \"List tasks\"\n operationId: \"TaskList\"\n produces:\n - \"application/json\"\n responses:\n 200:\n description: \"no error\"\n schema:\n type: \"array\"\n items:\n $ref: \"#/definitions/Task\"\n example:\n - ID: \"0kzzo1i0y4jz6027t0k7aezc7\"\n Version:\n Index: 71\n CreatedAt: \"2016-06-07T21:07:31.171892745Z\"\n UpdatedAt: \"2016-06-07T21:07:31.376370513Z\"\n Spec:\n ContainerSpec:\n Image: \"redis\"\n Resources:\n Limits: {}\n Reservations: {}\n RestartPolicy:\n Condition: \"any\"\n MaxAttempts: 0\n Placement: {}\n ServiceID: \"9mnpnzenvg8p8tdbtq4wvbkcz\"\n Slot: 1\n NodeID: \"60gvrl6tm78dmak4yl7srz94v\"\n Status:\n Timestamp: \"2016-06-07T21:07:31.290032978Z\"\n State: \"running\"\n Message: \"started\"\n ContainerStatus:\n ContainerID: \"e5d62702a1b48d01c3e02ca1e0212a250801fa8d67caca0b6f35919ebc12f035\"\n PID: 677\n DesiredState: \"running\"\n NetworksAttachments:\n - Network:\n ID: \"4qvuz4ko70xaltuqbt8956gd1\"\n Version:\n Index: 18\n CreatedAt: \"2016-06-07T20:31:11.912919752Z\"\n UpdatedAt: \"2016-06-07T21:07:29.955277358Z\"\n Spec:\n Name: \"ingress\"\n Labels:\n com.docker.swarm.internal: \"true\"\n DriverConfiguration: {}\n IPAMOptions:\n Driver: {}\n Configs:\n - Subnet: \"10.255.0.0/16\"\n Gateway: \"10.255.0.1\"\n DriverState:\n Name: \"overlay\"\n Options:\n com.docker.network.driver.overlay.vxlanid_list: \"256\"\n IPAMOptions:\n Driver:\n Name: \"default\"\n Configs:\n - Subnet: \"10.255.0.0/16\"\n Gateway: \"10.255.0.1\"\n Addresses:\n - \"10.255.0.10/16\"\n - ID: \"1yljwbmlr8er2waf8orvqpwms\"\n Version:\n Index: 30\n CreatedAt: \"2016-06-07T21:07:30.019104782Z\"\n UpdatedAt: \"2016-06-07T21:07:30.231958098Z\"\n Name: \"hopeful_cori\"\n Spec:\n ContainerSpec:\n Image: \"redis\"\n Resources:\n Limits: {}\n Reservations: {}\n RestartPolicy:\n Condition: \"any\"\n MaxAttempts: 0\n Placement: {}\n ServiceID: \"9mnpnzenvg8p8tdbtq4wvbkcz\"\n Slot: 1\n NodeID: \"60gvrl6tm78dmak4yl7srz94v\"\n Status:\n Timestamp: \"2016-06-07T21:07:30.202183143Z\"\n State: \"shutdown\"\n Message: \"shutdown\"\n ContainerStatus:\n ContainerID: \"1cf8d63d18e79668b0004a4be4c6ee58cddfad2dae29506d8781581d0688a213\"\n DesiredState: \"shutdown\"\n NetworksAttachments:\n - Network:\n ID: \"4qvuz4ko70xaltuqbt8956gd1\"\n Version:\n Index: 18\n CreatedAt: \"2016-06-07T20:31:11.912919752Z\"\n UpdatedAt: \"2016-06-07T21:07:29.955277358Z\"\n Spec:\n Name: \"ingress\"\n Labels:\n com.docker.swarm.internal: \"true\"\n DriverConfiguration: {}\n IPAMOptions:\n Driver: {}\n Configs:\n - Subnet: \"10.255.0.0/16\"\n Gateway: \"10.255.0.1\"\n DriverState:\n Name: \"overlay\"\n Options:\n com.docker.network.driver.overlay.vxlanid_list: \"256\"\n IPAMOptions:\n Driver:\n Name: \"default\"\n Configs:\n - Subnet: \"10.255.0.0/16\"\n Gateway: \"10.255.0.1\"\n Addresses:\n - \"10.255.0.5/16\"\n 500:\n description: \"server error\"\n schema:\n $ref: \"#/definitions/ErrorResponse\"\n 503:\n description: \"node is not part of a swarm\"\n schema:\n $ref: \"#/definitions/ErrorResponse\"\n parameters:\n - name: \"filters\"\n in: \"query\"\n type: \"string\"\n description: |\n A JSON encoded value of the filters (a `map[string][]string`) to\n process on the tasks list.\n\n Available filters:\n\n - `desired-state=(running | shutdown | accepted)`\n - `id=`\n - `label=key` or `label=\"key=value\"`\n - `name=`\n - `node=`\n - `service=`\n tags: [\"Task\"]\n /tasks/{id}:\n get:\n summary: \"Inspect a task\"\n operationId: \"TaskInspect\"\n produces:\n - \"application/json\"\n responses:\n 200:\n description: \"no error\"\n schema:\n $ref: \"#/definitions/Task\"\n 404:\n description: \"no such task\"\n schema:\n $ref: \"#/definitions/ErrorResponse\"\n 500:\n description: \"server error\"\n schema:\n $ref: \"#/definitions/ErrorResponse\"\n 503:\n description: \"node is not part of a swarm\"\n schema:\n $ref: \"#/definitions/ErrorResponse\"\n parameters:\n - name: \"id\"\n in: \"path\"\n description: \"ID of the task\"\n required: true\n type: \"string\"\n tags: [\"Task\"]\n /tasks/{id}/logs:\n get:\n summary: \"Get task logs\"\n description: |\n Get `stdout` and `stderr` logs from a task.\n See also [`/containers/{id}/logs`](#operation/ContainerLogs).\n\n **Note**: This endpoint works only for services with the `local`,\n `json-file` or `journald` logging drivers.\n operationId: \"TaskLogs\"\n responses:\n 200:\n description: \"logs returned as a stream in response body\"\n schema:\n type: \"string\"\n format: \"binary\"\n 404:\n description: \"no such task\"\n schema:\n $ref: \"#/definitions/ErrorResponse\"\n examples:\n application/json:\n message: \"No such task: c2ada9df5af8\"\n 500:\n description: \"server error\"\n schema:\n $ref: \"#/definitions/ErrorResponse\"\n 503:\n description: \"node is not part of a swarm\"\n schema:\n $ref: \"#/definitions/ErrorResponse\"\n parameters:\n - name: \"id\"\n in: \"path\"\n required: true\n description: \"ID of the task\"\n type: \"string\"\n - name: \"details\"\n in: \"query\"\n description: \"Show task context and extra details provided to logs.\"\n type: \"boolean\"\n default: false\n - name: \"follow\"\n in: \"query\"\n description: \"Keep connection after returning logs.\"\n type: \"boolean\"\n default: false\n - name: \"stdout\"\n in: \"query\"\n description: \"Return logs from `stdout`\"\n type: \"boolean\"\n default: false\n - name: \"stderr\"\n in: \"query\"\n description: \"Return logs from `stderr`\"\n type: \"boolean\"\n default: false\n - name: \"since\"\n in: \"query\"\n description: \"Only return logs since this time, as a UNIX timestamp\"\n type: \"integer\"\n default: 0\n - name: \"timestamps\"\n in: \"query\"\n description: \"Add timestamps to every log line\"\n type: \"boolean\"\n default: false\n - name: \"tail\"\n in: \"query\"\n description: |\n Only return this number of log lines from the end of the logs.\n Specify as an integer or `all` to output all log lines.\n type: \"string\"\n default: \"all\"\n tags: [\"Task\"]\n /secrets:\n get:\n summary: \"List secrets\"\n operationId: \"SecretList\"\n produces:\n - \"application/json\"\n responses:\n 200:\n description: \"no error\"\n schema:\n type: \"array\"\n items:\n $ref: \"#/definitions/Secret\"\n example:\n - ID: \"blt1owaxmitz71s9v5zh81zun\"\n Version:\n Index: 85\n CreatedAt: \"2017-07-20T13:55:28.678958722Z\"\n UpdatedAt: \"2017-07-20T13:55:28.678958722Z\"\n Spec:\n Name: \"mysql-passwd\"\n Labels:\n some.label: \"some.value\"\n Driver:\n Name: \"secret-bucket\"\n Options:\n OptionA: \"value for driver option A\"\n OptionB: \"value for driver option B\"\n - ID: \"ktnbjxoalbkvbvedmg1urrz8h\"\n Version:\n Index: 11\n CreatedAt: \"2016-11-05T01:20:17.327670065Z\"\n UpdatedAt: \"2016-11-05T01:20:17.327670065Z\"\n Spec:\n Name: \"app-dev.crt\"\n Labels:\n foo: \"bar\"\n 500:\n description: \"server error\"\n schema:\n $ref: \"#/definitions/ErrorResponse\"\n 503:\n description: \"node is not part of a swarm\"\n schema:\n $ref: \"#/definitions/ErrorResponse\"\n parameters:\n - name: \"filters\"\n in: \"query\"\n type: \"string\"\n description: |\n A JSON encoded value of the filters (a `map[string][]string`) to\n process on the secrets list.\n\n Available filters:\n\n - `id=`\n - `label= or label==value`\n - `name=`\n - `names=`\n tags: [\"Secret\"]\n /secrets/create:\n post:\n summary: \"Create a secret\"\n operationId: \"SecretCreate\"\n consumes:\n - \"application/json\"\n produces:\n - \"application/json\"\n responses:\n 201:\n description: \"no error\"\n schema:\n $ref: \"#/definitions/IdResponse\"\n 409:\n description: \"name conflicts with an existing object\"\n schema:\n $ref: \"#/definitions/ErrorResponse\"\n 500:\n description: \"server error\"\n schema:\n $ref: \"#/definitions/ErrorResponse\"\n 503:\n description: \"node is not part of a swarm\"\n schema:\n $ref: \"#/definitions/ErrorResponse\"\n parameters:\n - name: \"body\"\n in: \"body\"\n schema:\n allOf:\n - $ref: \"#/definitions/SecretSpec\"\n - type: \"object\"\n example:\n Name: \"app-key.crt\"\n Labels:\n foo: \"bar\"\n Data: \"VEhJUyBJUyBOT1QgQSBSRUFMIENFUlRJRklDQVRFCg==\"\n Driver:\n Name: \"secret-bucket\"\n Options:\n OptionA: \"value for driver option A\"\n OptionB: \"value for driver option B\"\n tags: [\"Secret\"]\n /secrets/{id}:\n get:\n summary: \"Inspect a secret\"\n operationId: \"SecretInspect\"\n produces:\n - \"application/json\"\n responses:\n 200:\n description: \"no error\"\n schema:\n $ref: \"#/definitions/Secret\"\n examples:\n application/json:\n ID: \"ktnbjxoalbkvbvedmg1urrz8h\"\n Version:\n Index: 11\n CreatedAt: \"2016-11-05T01:20:17.327670065Z\"\n UpdatedAt: \"2016-11-05T01:20:17.327670065Z\"\n Spec:\n Name: \"app-dev.crt\"\n Labels:\n foo: \"bar\"\n Driver:\n Name: \"secret-bucket\"\n Options:\n OptionA: \"value for driver option A\"\n OptionB: \"value for driver option B\"\n\n 404:\n description: \"secret not found\"\n schema:\n $ref: \"#/definitions/ErrorResponse\"\n 500:\n description: \"server error\"\n schema:\n $ref: \"#/definitions/ErrorResponse\"\n 503:\n description: \"node is not part of a swarm\"\n schema:\n $ref: \"#/definitions/ErrorResponse\"\n parameters:\n - name: \"id\"\n in: \"path\"\n required: true\n type: \"string\"\n description: \"ID of the secret\"\n tags: [\"Secret\"]\n delete:\n summary: \"Delete a secret\"\n operationId: \"SecretDelete\"\n produces:\n - \"application/json\"\n responses:\n 204:\n description: \"no error\"\n 404:\n description: \"secret not found\"\n schema:\n $ref: \"#/definitions/ErrorResponse\"\n 500:\n description: \"server error\"\n schema:\n $ref: \"#/definitions/ErrorResponse\"\n 503:\n description: \"node is not part of a swarm\"\n schema:\n $ref: \"#/definitions/ErrorResponse\"\n parameters:\n - name: \"id\"\n in: \"path\"\n required: true\n type: \"string\"\n description: \"ID of the secret\"\n tags: [\"Secret\"]\n /secrets/{id}/update:\n post:\n summary: \"Update a Secret\"\n operationId: \"SecretUpdate\"\n responses:\n 200:\n description: \"no error\"\n 400:\n description: \"bad parameter\"\n schema:\n $ref: \"#/definitions/ErrorResponse\"\n 404:\n description: \"no such secret\"\n schema:\n $ref: \"#/definitions/ErrorResponse\"\n 500:\n description: \"server error\"\n schema:\n $ref: \"#/definitions/ErrorResponse\"\n 503:\n description: \"node is not part of a swarm\"\n schema:\n $ref: \"#/definitions/ErrorResponse\"\n parameters:\n - name: \"id\"\n in: \"path\"\n description: \"The ID or name of the secret\"\n type: \"string\"\n required: true\n - name: \"body\"\n in: \"body\"\n schema:\n $ref: \"#/definitions/SecretSpec\"\n description: |\n The spec of the secret to update. Currently, only the Labels field\n can be updated. All other fields must remain unchanged from the\n [SecretInspect endpoint](#operation/SecretInspect) response values.\n - name: \"version\"\n in: \"query\"\n description: |\n The version number of the secret object being updated. This is\n required to avoid conflicting writes.\n type: \"integer\"\n format: \"int64\"\n required: true\n tags: [\"Secret\"]\n /configs:\n get:\n summary: \"List configs\"\n operationId: \"ConfigList\"\n produces:\n - \"application/json\"\n responses:\n 200:\n description: \"no error\"\n schema:\n type: \"array\"\n items:\n $ref: \"#/definitions/Config\"\n example:\n - ID: \"ktnbjxoalbkvbvedmg1urrz8h\"\n Version:\n Index: 11\n CreatedAt: \"2016-11-05T01:20:17.327670065Z\"\n UpdatedAt: \"2016-11-05T01:20:17.327670065Z\"\n Spec:\n Name: \"server.conf\"\n 500:\n description: \"server error\"\n schema:\n $ref: \"#/definitions/ErrorResponse\"\n 503:\n description: \"node is not part of a swarm\"\n schema:\n $ref: \"#/definitions/ErrorResponse\"\n parameters:\n - name: \"filters\"\n in: \"query\"\n type: \"string\"\n description: |\n A JSON encoded value of the filters (a `map[string][]string`) to\n process on the configs list.\n\n Available filters:\n\n - `id=`\n - `label= or label==value`\n - `name=`\n - `names=`\n tags: [\"Config\"]\n /configs/create:\n post:\n summary: \"Create a config\"\n operationId: \"ConfigCreate\"\n consumes:\n - \"application/json\"\n produces:\n - \"application/json\"\n responses:\n 201:\n description: \"no error\"\n schema:\n $ref: \"#/definitions/IdResponse\"\n 409:\n description: \"name conflicts with an existing object\"\n schema:\n $ref: \"#/definitions/ErrorResponse\"\n 500:\n description: \"server error\"\n schema:\n $ref: \"#/definitions/ErrorResponse\"\n 503:\n description: \"node is not part of a swarm\"\n schema:\n $ref: \"#/definitions/ErrorResponse\"\n parameters:\n - name: \"body\"\n in: \"body\"\n schema:\n allOf:\n - $ref: \"#/definitions/ConfigSpec\"\n - type: \"object\"\n example:\n Name: \"server.conf\"\n Labels:\n foo: \"bar\"\n Data: \"VEhJUyBJUyBOT1QgQSBSRUFMIENFUlRJRklDQVRFCg==\"\n tags: [\"Config\"]\n /configs/{id}:\n get:\n summary: \"Inspect a config\"\n operationId: \"ConfigInspect\"\n produces:\n - \"application/json\"\n responses:\n 200:\n description: \"no error\"\n schema:\n $ref: \"#/definitions/Config\"\n examples:\n application/json:\n ID: \"ktnbjxoalbkvbvedmg1urrz8h\"\n Version:\n Index: 11\n CreatedAt: \"2016-11-05T01:20:17.327670065Z\"\n UpdatedAt: \"2016-11-05T01:20:17.327670065Z\"\n Spec:\n Name: \"app-dev.crt\"\n 404:\n description: \"config not found\"\n schema:\n $ref: \"#/definitions/ErrorResponse\"\n 500:\n description: \"server error\"\n schema:\n $ref: \"#/definitions/ErrorResponse\"\n 503:\n description: \"node is not part of a swarm\"\n schema:\n $ref: \"#/definitions/ErrorResponse\"\n parameters:\n - name: \"id\"\n in: \"path\"\n required: true\n type: \"string\"\n description: \"ID of the config\"\n tags: [\"Config\"]\n delete:\n summary: \"Delete a config\"\n operationId: \"ConfigDelete\"\n produces:\n - \"application/json\"\n responses:\n 204:\n description: \"no error\"\n 404:\n description: \"config not found\"\n schema:\n $ref: \"#/definitions/ErrorResponse\"\n 500:\n description: \"server error\"\n schema:\n $ref: \"#/definitions/ErrorResponse\"\n 503:\n description: \"node is not part of a swarm\"\n schema:\n $ref: \"#/definitions/ErrorResponse\"\n parameters:\n - name: \"id\"\n in: \"path\"\n required: true\n type: \"string\"\n description: \"ID of the config\"\n tags: [\"Config\"]\n /configs/{id}/update:\n post:\n summary: \"Update a Config\"\n operationId: \"ConfigUpdate\"\n responses:\n 200:\n description: \"no error\"\n 400:\n description: \"bad parameter\"\n schema:\n $ref: \"#/definitions/ErrorResponse\"\n 404:\n description: \"no such config\"\n schema:\n $ref: \"#/definitions/ErrorResponse\"\n 500:\n description: \"server error\"\n schema:\n $ref: \"#/definitions/ErrorResponse\"\n 503:\n description: \"node is not part of a swarm\"\n schema:\n $ref: \"#/definitions/ErrorResponse\"\n parameters:\n - name: \"id\"\n in: \"path\"\n description: \"The ID or name of the config\"\n type: \"string\"\n required: true\n - name: \"body\"\n in: \"body\"\n schema:\n $ref: \"#/definitions/ConfigSpec\"\n description: |\n The spec of the config to update. Currently, only the Labels field\n can be updated. All other fields must remain unchanged from the\n [ConfigInspect endpoint](#operation/ConfigInspect) response values.\n - name: \"version\"\n in: \"query\"\n description: |\n The version number of the config object being updated. This is\n required to avoid conflicting writes.\n type: \"integer\"\n format: \"int64\"\n required: true\n tags: [\"Config\"]\n /distribution/{name}/json:\n get:\n summary: \"Get image information from the registry\"\n description: |\n Return image digest and platform information by contacting the registry.\n operationId: \"DistributionInspect\"\n produces:\n - \"application/json\"\n responses:\n 200:\n description: \"descriptor and platform information\"\n schema:\n type: \"object\"\n x-go-name: DistributionInspect\n title: \"DistributionInspectResponse\"\n required: [Descriptor, Platforms]\n properties:\n Descriptor:\n type: \"object\"\n description: |\n A descriptor struct containing digest, media type, and size.\n properties:\n MediaType:\n type: \"string\"\n Size:\n type: \"integer\"\n format: \"int64\"\n Digest:\n type: \"string\"\n URLs:\n type: \"array\"\n items:\n type: \"string\"\n Platforms:\n type: \"array\"\n description: |\n An array containing all platforms supported by the image.\n items:\n type: \"object\"\n properties:\n Architecture:\n type: \"string\"\n OS:\n type: \"string\"\n OSVersion:\n type: \"string\"\n OSFeatures:\n type: \"array\"\n items:\n type: \"string\"\n Variant:\n type: \"string\"\n Features:\n type: \"array\"\n items:\n type: \"string\"\n examples:\n application/json:\n Descriptor:\n MediaType: \"application/vnd.docker.distribution.manifest.v2+json\"\n Digest: \"sha256:c0537ff6a5218ef531ece93d4984efc99bbf3f7497c0a7726c88e2bb7584dc96\"\n Size: 3987495\n URLs:\n - \"\"\n Platforms:\n - Architecture: \"amd64\"\n OS: \"linux\"\n OSVersion: \"\"\n OSFeatures:\n - \"\"\n Variant: \"\"\n Features:\n - \"\"\n 401:\n description: \"Failed authentication or no image found\"\n schema:\n $ref: \"#/definitions/ErrorResponse\"\n examples:\n application/json:\n message: \"No such image: someimage (tag: latest)\"\n 500:\n description: \"Server error\"\n schema:\n $ref: \"#/definitions/ErrorResponse\"\n parameters:\n - name: \"name\"\n in: \"path\"\n description: \"Image name or id\"\n type: \"string\"\n required: true\n tags: [\"Distribution\"]\n /session:\n post:\n summary: \"Initialize interactive session\"\n description: |\n Start a new interactive session with a server. Session allows server to\n call back to the client for advanced capabilities.\n\n ### Hijacking\n\n This endpoint hijacks the HTTP connection to HTTP2 transport that allows\n the client to expose gPRC services on that connection.\n\n For example, the client sends this request to upgrade the connection:\n\n ```\n POST /session HTTP/1.1\n Upgrade: h2c\n Connection: Upgrade\n ```\n\n The Docker daemon responds with a `101 UPGRADED` response follow with\n the raw stream:\n\n ```\n HTTP/1.1 101 UPGRADED\n Connection: Upgrade\n Upgrade: h2c\n ```\n operationId: \"Session\"\n produces:\n - \"application/vnd.docker.raw-stream\"\n responses:\n 101:\n description: \"no error, hijacking successful\"\n 400:\n description: \"bad parameter\"\n schema:\n $ref: \"#/definitions/ErrorResponse\"\n 500:\n description: \"server error\"\n schema:\n $ref: \"#/definitions/ErrorResponse\"\n tags: [\"Session\"]\n"},"after_content":{"kind":"string","value":"# A Swagger 2.0 (a.k.a. OpenAPI) definition of the Engine API.\n#\n# This is used for generating API documentation and the types used by the\n# client/server. See api/README.md for more information.\n#\n# Some style notes:\n# - This file is used by ReDoc, which allows GitHub Flavored Markdown in\n# descriptions.\n# - There is no maximum line length, for ease of editing and pretty diffs.\n# - operationIds are in the format \"NounVerb\", with a singular noun.\n\nswagger: \"2.0\"\nschemes:\n - \"http\"\n - \"https\"\nproduces:\n - \"application/json\"\n - \"text/plain\"\nconsumes:\n - \"application/json\"\n - \"text/plain\"\nbasePath: \"/v1.42\"\ninfo:\n title: \"Docker Engine API\"\n version: \"1.42\"\n x-logo:\n url: \"https://docs.docker.com/images/logo-docker-main.png\"\n description: |\n The Engine API is an HTTP API served by Docker Engine. It is the API the\n Docker client uses to communicate with the Engine, so everything the Docker\n client can do can be done with the API.\n\n Most of the client's commands map directly to API endpoints (e.g. `docker ps`\n is `GET /containers/json`). The notable exception is running containers,\n which consists of several API calls.\n\n # Errors\n\n The API uses standard HTTP status codes to indicate the success or failure\n of the API call. The body of the response will be JSON in the following\n format:\n\n ```\n {\n \"message\": \"page not found\"\n }\n ```\n\n # Versioning\n\n The API is usually changed in each release, so API calls are versioned to\n ensure that clients don't break. To lock to a specific version of the API,\n you prefix the URL with its version, for example, call `/v1.30/info` to use\n the v1.30 version of the `/info` endpoint. If the API version specified in\n the URL is not supported by the daemon, a HTTP `400 Bad Request` error message\n is returned.\n\n If you omit the version-prefix, the current version of the API (v1.42) is used.\n For example, calling `/info` is the same as calling `/v1.42/info`. Using the\n API without a version-prefix is deprecated and will be removed in a future release.\n\n Engine releases in the near future should support this version of the API,\n so your client will continue to work even if it is talking to a newer Engine.\n\n The API uses an open schema model, which means server may add extra properties\n to responses. Likewise, the server will ignore any extra query parameters and\n request body properties. When you write clients, you need to ignore additional\n properties in responses to ensure they do not break when talking to newer\n daemons.\n\n\n # Authentication\n\n Authentication for registries is handled client side. The client has to send\n authentication details to various endpoints that need to communicate with\n registries, such as `POST /images/(name)/push`. These are sent as\n `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5)\n (JSON) string with the following structure:\n\n ```\n {\n \"username\": \"string\",\n \"password\": \"string\",\n \"email\": \"string\",\n \"serveraddress\": \"string\"\n }\n ```\n\n The `serveraddress` is a domain/IP without a protocol. Throughout this\n structure, double quotes are required.\n\n If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth),\n you can just pass this instead of credentials:\n\n ```\n {\n \"identitytoken\": \"9cbaf023786cd7...\"\n }\n ```\n\n# The tags on paths define the menu sections in the ReDoc documentation, so\n# the usage of tags must make sense for that:\n# - They should be singular, not plural.\n# - There should not be too many tags, or the menu becomes unwieldy. For\n# example, it is preferable to add a path to the \"System\" tag instead of\n# creating a tag with a single path in it.\n# - The order of tags in this list defines the order in the menu.\ntags:\n # Primary objects\n - name: \"Container\"\n x-displayName: \"Containers\"\n description: |\n Create and manage containers.\n - name: \"Image\"\n x-displayName: \"Images\"\n - name: \"Network\"\n x-displayName: \"Networks\"\n description: |\n Networks are user-defined networks that containers can be attached to.\n See the [networking documentation](https://docs.docker.com/network/)\n for more information.\n - name: \"Volume\"\n x-displayName: \"Volumes\"\n description: |\n Create and manage persistent storage that can be attached to containers.\n - name: \"Exec\"\n x-displayName: \"Exec\"\n description: |\n Run new commands inside running containers. Refer to the\n [command-line reference](https://docs.docker.com/engine/reference/commandline/exec/)\n for more information.\n\n To exec a command in a container, you first need to create an exec instance,\n then start it. These two API endpoints are wrapped up in a single command-line\n command, `docker exec`.\n\n # Swarm things\n - name: \"Swarm\"\n x-displayName: \"Swarm\"\n description: |\n Engines can be clustered together in a swarm. Refer to the\n [swarm mode documentation](https://docs.docker.com/engine/swarm/)\n for more information.\n - name: \"Node\"\n x-displayName: \"Nodes\"\n description: |\n Nodes are instances of the Engine participating in a swarm. Swarm mode\n must be enabled for these endpoints to work.\n - name: \"Service\"\n x-displayName: \"Services\"\n description: |\n Services are the definitions of tasks to run on a swarm. Swarm mode must\n be enabled for these endpoints to work.\n - name: \"Task\"\n x-displayName: \"Tasks\"\n description: |\n A task is a container running on a swarm. It is the atomic scheduling unit\n of swarm. Swarm mode must be enabled for these endpoints to work.\n - name: \"Secret\"\n x-displayName: \"Secrets\"\n description: |\n Secrets are sensitive data that can be used by services. Swarm mode must\n be enabled for these endpoints to work.\n - name: \"Config\"\n x-displayName: \"Configs\"\n description: |\n Configs are application configurations that can be used by services. Swarm\n mode must be enabled for these endpoints to work.\n # System things\n - name: \"Plugin\"\n x-displayName: \"Plugins\"\n - name: \"System\"\n x-displayName: \"System\"\n\ndefinitions:\n Port:\n type: \"object\"\n description: \"An open port on a container\"\n required: [PrivatePort, Type]\n properties:\n IP:\n type: \"string\"\n format: \"ip-address\"\n description: \"Host IP address that the container's port is mapped to\"\n PrivatePort:\n type: \"integer\"\n format: \"uint16\"\n x-nullable: false\n description: \"Port on the container\"\n PublicPort:\n type: \"integer\"\n format: \"uint16\"\n description: \"Port exposed on the host\"\n Type:\n type: \"string\"\n x-nullable: false\n enum: [\"tcp\", \"udp\", \"sctp\"]\n example:\n PrivatePort: 8080\n PublicPort: 80\n Type: \"tcp\"\n\n MountPoint:\n type: \"object\"\n description: \"A mount point inside a container\"\n properties:\n Type:\n type: \"string\"\n Name:\n type: \"string\"\n Source:\n type: \"string\"\n Destination:\n type: \"string\"\n Driver:\n type: \"string\"\n Mode:\n type: \"string\"\n RW:\n type: \"boolean\"\n Propagation:\n type: \"string\"\n\n DeviceMapping:\n type: \"object\"\n description: \"A device mapping between the host and container\"\n properties:\n PathOnHost:\n type: \"string\"\n PathInContainer:\n type: \"string\"\n CgroupPermissions:\n type: \"string\"\n example:\n PathOnHost: \"/dev/deviceName\"\n PathInContainer: \"/dev/deviceName\"\n CgroupPermissions: \"mrw\"\n\n DeviceRequest:\n type: \"object\"\n description: \"A request for devices to be sent to device drivers\"\n properties:\n Driver:\n type: \"string\"\n example: \"nvidia\"\n Count:\n type: \"integer\"\n example: -1\n DeviceIDs:\n type: \"array\"\n items:\n type: \"string\"\n example:\n - \"0\"\n - \"1\"\n - \"GPU-fef8089b-4820-abfc-e83e-94318197576e\"\n Capabilities:\n description: |\n A list of capabilities; an OR list of AND lists of capabilities.\n type: \"array\"\n items:\n type: \"array\"\n items:\n type: \"string\"\n example:\n # gpu AND nvidia AND compute\n - [\"gpu\", \"nvidia\", \"compute\"]\n Options:\n description: |\n Driver-specific options, specified as a key/value pairs. These options\n are passed directly to the driver.\n type: \"object\"\n additionalProperties:\n type: \"string\"\n\n ThrottleDevice:\n type: \"object\"\n properties:\n Path:\n description: \"Device path\"\n type: \"string\"\n Rate:\n description: \"Rate\"\n type: \"integer\"\n format: \"int64\"\n minimum: 0\n\n Mount:\n type: \"object\"\n properties:\n Target:\n description: \"Container path.\"\n type: \"string\"\n Source:\n description: \"Mount source (e.g. a volume name, a host path).\"\n type: \"string\"\n Type:\n description: |\n The mount type. Available types:\n\n - `bind` Mounts a file or directory from the host into the container. Must exist prior to creating the container.\n - `volume` Creates a volume with the given name and options (or uses a pre-existing volume with the same name and options). These are **not** removed when the container is removed.\n - `tmpfs` Create a tmpfs with the given options. The mount source cannot be specified for tmpfs.\n - `npipe` Mounts a named pipe from the host into the container. Must exist prior to creating the container.\n type: \"string\"\n enum:\n - \"bind\"\n - \"volume\"\n - \"tmpfs\"\n - \"npipe\"\n ReadOnly:\n description: \"Whether the mount should be read-only.\"\n type: \"boolean\"\n Consistency:\n description: \"The consistency requirement for the mount: `default`, `consistent`, `cached`, or `delegated`.\"\n type: \"string\"\n BindOptions:\n description: \"Optional configuration for the `bind` type.\"\n type: \"object\"\n properties:\n Propagation:\n description: \"A propagation mode with the value `[r]private`, `[r]shared`, or `[r]slave`.\"\n type: \"string\"\n enum:\n - \"private\"\n - \"rprivate\"\n - \"shared\"\n - \"rshared\"\n - \"slave\"\n - \"rslave\"\n NonRecursive:\n description: \"Disable recursive bind mount.\"\n type: \"boolean\"\n default: false\n VolumeOptions:\n description: \"Optional configuration for the `volume` type.\"\n type: \"object\"\n properties:\n NoCopy:\n description: \"Populate volume with data from the target.\"\n type: \"boolean\"\n default: false\n Labels:\n description: \"User-defined key/value metadata.\"\n type: \"object\"\n additionalProperties:\n type: \"string\"\n DriverConfig:\n description: \"Map of driver specific options\"\n type: \"object\"\n properties:\n Name:\n description: \"Name of the driver to use to create the volume.\"\n type: \"string\"\n Options:\n description: \"key/value map of driver specific options.\"\n type: \"object\"\n additionalProperties:\n type: \"string\"\n TmpfsOptions:\n description: \"Optional configuration for the `tmpfs` type.\"\n type: \"object\"\n properties:\n SizeBytes:\n description: \"The size for the tmpfs mount in bytes.\"\n type: \"integer\"\n format: \"int64\"\n Mode:\n description: \"The permission mode for the tmpfs mount in an integer.\"\n type: \"integer\"\n\n RestartPolicy:\n description: |\n The behavior to apply when the container exits. The default is not to\n restart.\n\n An ever increasing delay (double the previous delay, starting at 100ms) is\n added before each restart to prevent flooding the server.\n type: \"object\"\n properties:\n Name:\n type: \"string\"\n description: |\n - Empty string means not to restart\n - `no` Do not automatically restart\n - `always` Always restart\n - `unless-stopped` Restart always except when the user has manually stopped the container\n - `on-failure` Restart only when the container exit code is non-zero\n enum:\n - \"\"\n - \"no\"\n - \"always\"\n - \"unless-stopped\"\n - \"on-failure\"\n MaximumRetryCount:\n type: \"integer\"\n description: |\n If `on-failure` is used, the number of times to retry before giving up.\n\n Resources:\n description: \"A container's resources (cgroups config, ulimits, etc)\"\n type: \"object\"\n properties:\n # Applicable to all platforms\n CpuShares:\n description: |\n An integer value representing this container's relative CPU weight\n versus other containers.\n type: \"integer\"\n Memory:\n description: \"Memory limit in bytes.\"\n type: \"integer\"\n format: \"int64\"\n default: 0\n # Applicable to UNIX platforms\n CgroupParent:\n description: |\n Path to `cgroups` under which the container's `cgroup` is created. If\n the path is not absolute, the path is considered to be relative to the\n `cgroups` path of the init process. Cgroups are created if they do not\n already exist.\n type: \"string\"\n BlkioWeight:\n description: \"Block IO weight (relative weight).\"\n type: \"integer\"\n minimum: 0\n maximum: 1000\n BlkioWeightDevice:\n description: |\n Block IO weight (relative device weight) in the form:\n\n ```\n [{\"Path\": \"device_path\", \"Weight\": weight}]\n ```\n type: \"array\"\n items:\n type: \"object\"\n properties:\n Path:\n type: \"string\"\n Weight:\n type: \"integer\"\n minimum: 0\n BlkioDeviceReadBps:\n description: |\n Limit read rate (bytes per second) from a device, in the form:\n\n ```\n [{\"Path\": \"device_path\", \"Rate\": rate}]\n ```\n type: \"array\"\n items:\n $ref: \"#/definitions/ThrottleDevice\"\n BlkioDeviceWriteBps:\n description: |\n Limit write rate (bytes per second) to a device, in the form:\n\n ```\n [{\"Path\": \"device_path\", \"Rate\": rate}]\n ```\n type: \"array\"\n items:\n $ref: \"#/definitions/ThrottleDevice\"\n BlkioDeviceReadIOps:\n description: |\n Limit read rate (IO per second) from a device, in the form:\n\n ```\n [{\"Path\": \"device_path\", \"Rate\": rate}]\n ```\n type: \"array\"\n items:\n $ref: \"#/definitions/ThrottleDevice\"\n BlkioDeviceWriteIOps:\n description: |\n Limit write rate (IO per second) to a device, in the form:\n\n ```\n [{\"Path\": \"device_path\", \"Rate\": rate}]\n ```\n type: \"array\"\n items:\n $ref: \"#/definitions/ThrottleDevice\"\n CpuPeriod:\n description: \"The length of a CPU period in microseconds.\"\n type: \"integer\"\n format: \"int64\"\n CpuQuota:\n description: |\n Microseconds of CPU time that the container can get in a CPU period.\n type: \"integer\"\n format: \"int64\"\n CpuRealtimePeriod:\n description: |\n The length of a CPU real-time period in microseconds. Set to 0 to\n allocate no time allocated to real-time tasks.\n type: \"integer\"\n format: \"int64\"\n CpuRealtimeRuntime:\n description: |\n The length of a CPU real-time runtime in microseconds. Set to 0 to\n allocate no time allocated to real-time tasks.\n type: \"integer\"\n format: \"int64\"\n CpusetCpus:\n description: |\n CPUs in which to allow execution (e.g., `0-3`, `0,1`).\n type: \"string\"\n example: \"0-3\"\n CpusetMems:\n description: |\n Memory nodes (MEMs) in which to allow execution (0-3, 0,1). Only\n effective on NUMA systems.\n type: \"string\"\n Devices:\n description: \"A list of devices to add to the container.\"\n type: \"array\"\n items:\n $ref: \"#/definitions/DeviceMapping\"\n DeviceCgroupRules:\n description: \"a list of cgroup rules to apply to the container\"\n type: \"array\"\n items:\n type: \"string\"\n example: \"c 13:* rwm\"\n DeviceRequests:\n description: |\n A list of requests for devices to be sent to device drivers.\n type: \"array\"\n items:\n $ref: \"#/definitions/DeviceRequest\"\n KernelMemory:\n description: |\n Kernel memory limit in bytes.\n\n `. Any\n other value is taken as a custom network's name to which this\n container should connect to.\n PortBindings:\n $ref: \"#/definitions/PortMap\"\n RestartPolicy:\n $ref: \"#/definitions/RestartPolicy\"\n AutoRemove:\n type: \"boolean\"\n description: |\n Automatically remove the container when the container's process\n exits. This has no effect if `RestartPolicy` is set.\n VolumeDriver:\n type: \"string\"\n description: \"Driver that this container uses to mount volumes.\"\n VolumesFrom:\n type: \"array\"\n description: |\n A list of volumes to inherit from another container, specified in\n the form `[:]`.\n items:\n type: \"string\"\n Mounts:\n description: |\n Specification for mounts to be added to the container.\n type: \"array\"\n items:\n $ref: \"#/definitions/Mount\"\n\n # Applicable to UNIX platforms\n CapAdd:\n type: \"array\"\n description: |\n A list of kernel capabilities to add to the container. Conflicts\n with option 'Capabilities'.\n items:\n type: \"string\"\n CapDrop:\n type: \"array\"\n description: |\n A list of kernel capabilities to drop from the container. Conflicts\n with option 'Capabilities'.\n items:\n type: \"string\"\n CgroupnsMode:\n type: \"string\"\n enum:\n - \"private\"\n - \"host\"\n description: |\n cgroup namespace mode for the container. Possible values are:\n\n - `\"private\"`: the container runs in its own private cgroup namespace\n - `\"host\"`: use the host system's cgroup namespace\n\n If not specified, the daemon default is used, which can either be `\"private\"`\n or `\"host\"`, depending on daemon version, kernel support and configuration.\n Dns:\n type: \"array\"\n description: \"A list of DNS servers for the container to use.\"\n items:\n type: \"string\"\n DnsOptions:\n type: \"array\"\n description: \"A list of DNS options.\"\n items:\n type: \"string\"\n DnsSearch:\n type: \"array\"\n description: \"A list of DNS search domains.\"\n items:\n type: \"string\"\n ExtraHosts:\n type: \"array\"\n description: |\n A list of hostnames/IP mappings to add to the container's `/etc/hosts`\n file. Specified in the form `[\"hostname:IP\"]`.\n items:\n type: \"string\"\n GroupAdd:\n type: \"array\"\n description: |\n A list of additional groups that the container process will run as.\n items:\n type: \"string\"\n IpcMode:\n type: \"string\"\n description: |\n IPC sharing mode for the container. Possible values are:\n\n - `\"none\"`: own private IPC namespace, with /dev/shm not mounted\n - `\"private\"`: own private IPC namespace\n - `\"shareable\"`: own private IPC namespace, with a possibility to share it with other containers\n - `\"container:\"`: join another (shareable) container's IPC namespace\n - `\"host\"`: use the host system's IPC namespace\n\n If not specified, daemon default is used, which can either be `\"private\"`\n or `\"shareable\"`, depending on daemon version and configuration.\n Cgroup:\n type: \"string\"\n description: \"Cgroup to use for the container.\"\n Links:\n type: \"array\"\n description: |\n A list of links for the container in the form `container_name:alias`.\n items:\n type: \"string\"\n OomScoreAdj:\n type: \"integer\"\n description: |\n An integer value containing the score given to the container in\n order to tune OOM killer preferences.\n example: 500\n PidMode:\n type: \"string\"\n description: |\n Set the PID (Process) Namespace mode for the container. It can be\n either:\n\n - `\"container:\"`: joins another container's PID namespace\n - `\"host\"`: use the host's PID namespace inside the container\n Privileged:\n type: \"boolean\"\n description: \"Gives the container full access to the host.\"\n PublishAllPorts:\n type: \"boolean\"\n description: |\n Allocates an ephemeral host port for all of a container's\n exposed ports.\n\n Ports are de-allocated when the container stops and allocated when\n the container starts. The allocated port might be changed when\n restarting the container.\n\n The port is selected from the ephemeral port range that depends on\n the kernel. For example, on Linux the range is defined by\n `/proc/sys/net/ipv4/ip_local_port_range`.\n ReadonlyRootfs:\n type: \"boolean\"\n description: \"Mount the container's root filesystem as read only.\"\n SecurityOpt:\n type: \"array\"\n description: \"A list of string values to customize labels for MLS\n systems, such as SELinux.\"\n items:\n type: \"string\"\n StorageOpt:\n type: \"object\"\n description: |\n Storage driver options for this container, in the form `{\"size\": \"120G\"}`.\n additionalProperties:\n type: \"string\"\n Tmpfs:\n type: \"object\"\n description: |\n A map of container directories which should be replaced by tmpfs\n mounts, and their corresponding mount options. For example:\n\n ```\n { \"/run\": \"rw,noexec,nosuid,size=65536k\" }\n ```\n additionalProperties:\n type: \"string\"\n UTSMode:\n type: \"string\"\n description: \"UTS namespace to use for the container.\"\n UsernsMode:\n type: \"string\"\n description: |\n Sets the usernamespace mode for the container when usernamespace\n remapping option is enabled.\n ShmSize:\n type: \"integer\"\n description: |\n Size of `/dev/shm` in bytes. If omitted, the system uses 64MB.\n minimum: 0\n Sysctls:\n type: \"object\"\n description: |\n A list of kernel parameters (sysctls) to set in the container.\n For example:\n\n ```\n {\"net.ipv4.ip_forward\": \"1\"}\n ```\n additionalProperties:\n type: \"string\"\n Runtime:\n type: \"string\"\n description: \"Runtime to use with this container.\"\n # Applicable to Windows\n ConsoleSize:\n type: \"array\"\n description: |\n Initial console size, as an `[height, width]` array. (Windows only)\n minItems: 2\n maxItems: 2\n items:\n type: \"integer\"\n minimum: 0\n Isolation:\n type: \"string\"\n description: |\n Isolation technology of the container. (Windows only)\n enum:\n - \"default\"\n - \"process\"\n - \"hyperv\"\n MaskedPaths:\n type: \"array\"\n description: |\n The list of paths to be masked inside the container (this overrides\n the default set of paths).\n items:\n type: \"string\"\n ReadonlyPaths:\n type: \"array\"\n description: |\n The list of paths to be set as read-only inside the container\n (this overrides the default set of paths).\n items:\n type: \"string\"\n\n ContainerConfig:\n description: \"Configuration for a container that is portable between hosts\"\n type: \"object\"\n properties:\n Hostname:\n description: \"The hostname to use for the container, as a valid RFC 1123 hostname.\"\n type: \"string\"\n Domainname:\n description: \"The domain name to use for the container.\"\n type: \"string\"\n User:\n description: \"The user that commands are run as inside the container.\"\n type: \"string\"\n AttachStdin:\n description: \"Whether to attach to `stdin`.\"\n type: \"boolean\"\n default: false\n AttachStdout:\n description: \"Whether to attach to `stdout`.\"\n type: \"boolean\"\n default: true\n AttachStderr:\n description: \"Whether to attach to `stderr`.\"\n type: \"boolean\"\n default: true\n ExposedPorts:\n description: |\n An object mapping ports to an empty object in the form:\n\n `{\"/\": {}}`\n type: \"object\"\n additionalProperties:\n type: \"object\"\n enum:\n - {}\n default: {}\n Tty:\n description: |\n Attach standard streams to a TTY, including `stdin` if it is not closed.\n type: \"boolean\"\n default: false\n OpenStdin:\n description: \"Open `stdin`\"\n type: \"boolean\"\n default: false\n StdinOnce:\n description: \"Close `stdin` after one attached client disconnects\"\n type: \"boolean\"\n default: false\n Env:\n description: |\n A list of environment variables to set inside the container in the\n form `[\"VAR=value\", ...]`. A variable without `=` is removed from the\n environment, rather than to have an empty value.\n type: \"array\"\n items:\n type: \"string\"\n Cmd:\n description: |\n Command to run specified as a string or an array of strings.\n type: \"array\"\n items:\n type: \"string\"\n Healthcheck:\n $ref: \"#/definitions/HealthConfig\"\n ArgsEscaped:\n description: \"Command is already escaped (Windows only)\"\n type: \"boolean\"\n Image:\n description: |\n The name of the image to use when creating the container/\n type: \"string\"\n Volumes:\n description: |\n An object mapping mount point paths inside the container to empty\n objects.\n type: \"object\"\n additionalProperties:\n type: \"object\"\n enum:\n - {}\n default: {}\n WorkingDir:\n description: \"The working directory for commands to run in.\"\n type: \"string\"\n Entrypoint:\n description: |\n The entry point for the container as a string or an array of strings.\n\n If the array consists of exactly one empty string (`[\"\"]`) then the\n entry point is reset to system default (i.e., the entry point used by\n docker when there is no `ENTRYPOINT` instruction in the `Dockerfile`).\n type: \"array\"\n items:\n type: \"string\"\n NetworkDisabled:\n description: \"Disable networking for the container.\"\n type: \"boolean\"\n MacAddress:\n description: \"MAC address of the container.\"\n type: \"string\"\n OnBuild:\n description: |\n `ONBUILD` metadata that were defined in the image's `Dockerfile`.\n type: \"array\"\n items:\n type: \"string\"\n Labels:\n description: \"User-defined key/value metadata.\"\n type: \"object\"\n additionalProperties:\n type: \"string\"\n StopSignal:\n description: |\n Signal to stop a container as a string or unsigned integer.\n type: \"string\"\n default: \"SIGTERM\"\n StopTimeout:\n description: \"Timeout to stop a container in seconds.\"\n type: \"integer\"\n default: 10\n Shell:\n description: |\n Shell for when `RUN`, `CMD`, and `ENTRYPOINT` uses a shell.\n type: \"array\"\n items:\n type: \"string\"\n\n NetworkingConfig:\n description: |\n NetworkingConfig represents the container's networking configuration for\n each of its interfaces.\n It is used for the networking configs specified in the `docker create`\n and `docker network connect` commands.\n type: \"object\"\n properties:\n EndpointsConfig:\n description: |\n A mapping of network name to endpoint configuration for that network.\n type: \"object\"\n additionalProperties:\n $ref: \"#/definitions/EndpointSettings\"\n example:\n # putting an example here, instead of using the example values from\n # /definitions/EndpointSettings, because containers/create currently\n # does not support attaching to multiple networks, so the example request\n # would be confusing if it showed that multiple networks can be contained\n # in the EndpointsConfig.\n # TODO remove once we support multiple networks on container create (see https://github.com/moby/moby/blob/07e6b843594e061f82baa5fa23c2ff7d536c2a05/daemon/create.go#L323)\n EndpointsConfig:\n isolated_nw:\n IPAMConfig:\n IPv4Address: \"172.20.30.33\"\n IPv6Address: \"2001:db8:abcd::3033\"\n LinkLocalIPs:\n - \"169.254.34.68\"\n - \"fe80::3468\"\n Links:\n - \"container_1\"\n - \"container_2\"\n Aliases:\n - \"server_x\"\n - \"server_y\"\n\n NetworkSettings:\n description: \"NetworkSettings exposes the network settings in the API\"\n type: \"object\"\n properties:\n Bridge:\n description: Name of the network's bridge (for example, `docker0`).\n type: \"string\"\n example: \"docker0\"\n SandboxID:\n description: SandboxID uniquely represents a container's network stack.\n type: \"string\"\n example: \"9d12daf2c33f5959c8bf90aa513e4f65b561738661003029ec84830cd503a0c3\"\n HairpinMode:\n description: |\n Indicates if hairpin NAT should be enabled on the virtual interface.\n type: \"boolean\"\n example: false\n LinkLocalIPv6Address:\n description: IPv6 unicast address using the link-local prefix.\n type: \"string\"\n example: \"fe80::42:acff:fe11:1\"\n LinkLocalIPv6PrefixLen:\n description: Prefix length of the IPv6 unicast address.\n type: \"integer\"\n example: \"64\"\n Ports:\n $ref: \"#/definitions/PortMap\"\n SandboxKey:\n description: SandboxKey identifies the sandbox\n type: \"string\"\n example: \"/var/run/docker/netns/8ab54b426c38\"\n\n # TODO is SecondaryIPAddresses actually used?\n SecondaryIPAddresses:\n description: \"\"\n type: \"array\"\n items:\n $ref: \"#/definitions/Address\"\n x-nullable: true\n\n # TODO is SecondaryIPv6Addresses actually used?\n SecondaryIPv6Addresses:\n description: \"\"\n type: \"array\"\n items:\n $ref: \"#/definitions/Address\"\n x-nullable: true\n\n # TODO properties below are part of DefaultNetworkSettings, which is\n # marked as deprecated since Docker 1.9 and to be removed in Docker v17.12\n EndpointID:\n description: |\n EndpointID uniquely represents a service endpoint in a Sandbox.\n\n /`,\n for example, `80/udp`.\n\n If a container's port is mapped for multiple protocols, separate entries\n are added to the mapping table.\n type: \"object\"\n additionalProperties:\n type: \"array\"\n x-nullable: true\n items:\n $ref: \"#/definitions/PortBinding\"\n example:\n \"443/tcp\":\n - HostIp: \"127.0.0.1\"\n HostPort: \"4443\"\n \"80/tcp\":\n - HostIp: \"0.0.0.0\"\n HostPort: \"80\"\n - HostIp: \"0.0.0.0\"\n HostPort: \"8080\"\n \"80/udp\":\n - HostIp: \"0.0.0.0\"\n HostPort: \"80\"\n \"53/udp\":\n - HostIp: \"0.0.0.0\"\n HostPort: \"53\"\n \"2377/tcp\": null\n\n PortBinding:\n description: |\n PortBinding represents a binding between a host IP address and a host\n port.\n type: \"object\"\n properties:\n HostIp:\n description: \"Host IP address that the container's port is mapped to.\"\n type: \"string\"\n example: \"127.0.0.1\"\n HostPort:\n description: \"Host port number that the container's port is mapped to.\"\n type: \"string\"\n example: \"4443\"\n\n GraphDriverData:\n description: \"Information about a container's graph driver.\"\n type: \"object\"\n required: [Name, Data]\n properties:\n Name:\n type: \"string\"\n x-nullable: false\n Data:\n type: \"object\"\n x-nullable: false\n additionalProperties:\n type: \"string\"\n\n Image:\n type: \"object\"\n required:\n - Id\n - Parent\n - Comment\n - Created\n - Container\n - DockerVersion\n - Author\n - Architecture\n - Os\n - Size\n - VirtualSize\n - GraphDriver\n - RootFS\n properties:\n Id:\n type: \"string\"\n x-nullable: false\n RepoTags:\n type: \"array\"\n items:\n type: \"string\"\n RepoDigests:\n type: \"array\"\n items:\n type: \"string\"\n Parent:\n type: \"string\"\n x-nullable: false\n Comment:\n type: \"string\"\n x-nullable: false\n Created:\n type: \"string\"\n x-nullable: false\n Container:\n type: \"string\"\n x-nullable: false\n ContainerConfig:\n $ref: \"#/definitions/ContainerConfig\"\n DockerVersion:\n type: \"string\"\n x-nullable: false\n Author:\n type: \"string\"\n x-nullable: false\n Config:\n $ref: \"#/definitions/ContainerConfig\"\n Architecture:\n type: \"string\"\n x-nullable: false\n Os:\n type: \"string\"\n x-nullable: false\n OsVersion:\n type: \"string\"\n Size:\n type: \"integer\"\n format: \"int64\"\n x-nullable: false\n VirtualSize:\n type: \"integer\"\n format: \"int64\"\n x-nullable: false\n GraphDriver:\n $ref: \"#/definitions/GraphDriverData\"\n RootFS:\n type: \"object\"\n required: [Type]\n properties:\n Type:\n type: \"string\"\n x-nullable: false\n Layers:\n type: \"array\"\n items:\n type: \"string\"\n BaseLayer:\n type: \"string\"\n Metadata:\n type: \"object\"\n properties:\n LastTagTime:\n type: \"string\"\n format: \"dateTime\"\n\n ImageSummary:\n type: \"object\"\n required:\n - Id\n - ParentId\n - RepoTags\n - RepoDigests\n - Created\n - Size\n - SharedSize\n - VirtualSize\n - Labels\n - Containers\n properties:\n Id:\n type: \"string\"\n x-nullable: false\n ParentId:\n type: \"string\"\n x-nullable: false\n RepoTags:\n type: \"array\"\n x-nullable: false\n items:\n type: \"string\"\n RepoDigests:\n type: \"array\"\n x-nullable: false\n items:\n type: \"string\"\n Created:\n type: \"integer\"\n x-nullable: false\n Size:\n type: \"integer\"\n x-nullable: false\n SharedSize:\n type: \"integer\"\n x-nullable: false\n VirtualSize:\n type: \"integer\"\n x-nullable: false\n Labels:\n type: \"object\"\n x-nullable: false\n additionalProperties:\n type: \"string\"\n Containers:\n x-nullable: false\n type: \"integer\"\n\n AuthConfig:\n type: \"object\"\n properties:\n username:\n type: \"string\"\n password:\n type: \"string\"\n email:\n type: \"string\"\n serveraddress:\n type: \"string\"\n example:\n username: \"hannibal\"\n password: \"xxxx\"\n serveraddress: \"https://index.docker.io/v1/\"\n\n ProcessConfig:\n type: \"object\"\n properties:\n privileged:\n type: \"boolean\"\n user:\n type: \"string\"\n tty:\n type: \"boolean\"\n entrypoint:\n type: \"string\"\n arguments:\n type: \"array\"\n items:\n type: \"string\"\n\n Volume:\n type: \"object\"\n required: [Name, Driver, Mountpoint, Labels, Scope, Options]\n properties:\n Name:\n type: \"string\"\n description: \"Name of the volume.\"\n x-nullable: false\n Driver:\n type: \"string\"\n description: \"Name of the volume driver used by the volume.\"\n x-nullable: false\n Mountpoint:\n type: \"string\"\n description: \"Mount path of the volume on the host.\"\n x-nullable: false\n CreatedAt:\n type: \"string\"\n format: \"dateTime\"\n description: \"Date/Time the volume was created.\"\n Status:\n type: \"object\"\n description: |\n Low-level details about the volume, provided by the volume driver.\n Details are returned as a map with key/value pairs:\n `{\"key\":\"value\",\"key2\":\"value2\"}`.\n\n The `Status` field is optional, and is omitted if the volume driver\n does not support this feature.\n additionalProperties:\n type: \"object\"\n Labels:\n type: \"object\"\n description: \"User-defined key/value metadata.\"\n x-nullable: false\n additionalProperties:\n type: \"string\"\n Scope:\n type: \"string\"\n description: |\n The level at which the volume exists. Either `global` for cluster-wide,\n or `local` for machine level.\n default: \"local\"\n x-nullable: false\n enum: [\"local\", \"global\"]\n Options:\n type: \"object\"\n description: |\n The driver specific options used when creating the volume.\n additionalProperties:\n type: \"string\"\n UsageData:\n type: \"object\"\n x-nullable: true\n required: [Size, RefCount]\n description: |\n Usage details about the volume. This information is used by the\n `GET /system/df` endpoint, and omitted in other endpoints.\n properties:\n Size:\n type: \"integer\"\n default: -1\n description: |\n Amount of disk space used by the volume (in bytes). This information\n is only available for volumes created with the `\"local\"` volume\n driver. For volumes created with other volume drivers, this field\n is set to `-1` (\"not available\")\n x-nullable: false\n RefCount:\n type: \"integer\"\n default: -1\n description: |\n The number of containers referencing this volume. This field\n is set to `-1` if the reference-count is not available.\n x-nullable: false\n\n example:\n Name: \"tardis\"\n Driver: \"custom\"\n Mountpoint: \"/var/lib/docker/volumes/tardis\"\n Status:\n hello: \"world\"\n Labels:\n com.example.some-label: \"some-value\"\n com.example.some-other-label: \"some-other-value\"\n Scope: \"local\"\n CreatedAt: \"2016-06-07T20:31:11.853781916Z\"\n\n Network:\n type: \"object\"\n properties:\n Name:\n type: \"string\"\n Id:\n type: \"string\"\n Created:\n type: \"string\"\n format: \"dateTime\"\n Scope:\n type: \"string\"\n Driver:\n type: \"string\"\n EnableIPv6:\n type: \"boolean\"\n IPAM:\n $ref: \"#/definitions/IPAM\"\n Internal:\n type: \"boolean\"\n Attachable:\n type: \"boolean\"\n Ingress:\n type: \"boolean\"\n Containers:\n type: \"object\"\n additionalProperties:\n $ref: \"#/definitions/NetworkContainer\"\n Options:\n type: \"object\"\n additionalProperties:\n type: \"string\"\n Labels:\n type: \"object\"\n additionalProperties:\n type: \"string\"\n example:\n Name: \"net01\"\n Id: \"7d86d31b1478e7cca9ebed7e73aa0fdeec46c5ca29497431d3007d2d9e15ed99\"\n Created: \"2016-10-19T04:33:30.360899459Z\"\n Scope: \"local\"\n Driver: \"bridge\"\n EnableIPv6: false\n IPAM:\n Driver: \"default\"\n Config:\n - Subnet: \"172.19.0.0/16\"\n Gateway: \"172.19.0.1\"\n Options:\n foo: \"bar\"\n Internal: false\n Attachable: false\n Ingress: false\n Containers:\n 19a4d5d687db25203351ed79d478946f861258f018fe384f229f2efa4b23513c:\n Name: \"test\"\n EndpointID: \"628cadb8bcb92de107b2a1e516cbffe463e321f548feb37697cce00ad694f21a\"\n MacAddress: \"02:42:ac:13:00:02\"\n IPv4Address: \"172.19.0.2/16\"\n IPv6Address: \"\"\n Options:\n com.docker.network.bridge.default_bridge: \"true\"\n com.docker.network.bridge.enable_icc: \"true\"\n com.docker.network.bridge.enable_ip_masquerade: \"true\"\n com.docker.network.bridge.host_binding_ipv4: \"0.0.0.0\"\n com.docker.network.bridge.name: \"docker0\"\n com.docker.network.driver.mtu: \"1500\"\n Labels:\n com.example.some-label: \"some-value\"\n com.example.some-other-label: \"some-other-value\"\n IPAM:\n type: \"object\"\n properties:\n Driver:\n description: \"Name of the IPAM driver to use.\"\n type: \"string\"\n default: \"default\"\n Config:\n description: |\n List of IPAM configuration options, specified as a map:\n\n ```\n {\"Subnet\": , \"IPRange\": , \"Gateway\": , \"AuxAddress\": }\n ```\n type: \"array\"\n items:\n type: \"object\"\n additionalProperties:\n type: \"string\"\n Options:\n description: \"Driver-specific options, specified as a map.\"\n type: \"object\"\n additionalProperties:\n type: \"string\"\n\n NetworkContainer:\n type: \"object\"\n properties:\n Name:\n type: \"string\"\n EndpointID:\n type: \"string\"\n MacAddress:\n type: \"string\"\n IPv4Address:\n type: \"string\"\n IPv6Address:\n type: \"string\"\n\n BuildInfo:\n type: \"object\"\n properties:\n id:\n type: \"string\"\n stream:\n type: \"string\"\n error:\n type: \"string\"\n errorDetail:\n $ref: \"#/definitions/ErrorDetail\"\n status:\n type: \"string\"\n progress:\n type: \"string\"\n progressDetail:\n $ref: \"#/definitions/ProgressDetail\"\n aux:\n $ref: \"#/definitions/ImageID\"\n\n BuildCache:\n type: \"object\"\n properties:\n ID:\n type: \"string\"\n Parent:\n type: \"string\"\n Type:\n type: \"string\"\n Description:\n type: \"string\"\n InUse:\n type: \"boolean\"\n Shared:\n type: \"boolean\"\n Size:\n description: |\n Amount of disk space used by the build cache (in bytes).\n type: \"integer\"\n CreatedAt:\n description: |\n Date and time at which the build cache was created in\n [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format with nano-seconds.\n type: \"string\"\n format: \"dateTime\"\n example: \"2016-08-18T10:44:24.496525531Z\"\n LastUsedAt:\n description: |\n Date and time at which the build cache was last used in\n [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format with nano-seconds.\n type: \"string\"\n format: \"dateTime\"\n x-nullable: true\n example: \"2017-08-09T07:09:37.632105588Z\"\n UsageCount:\n type: \"integer\"\n\n ImageID:\n type: \"object\"\n description: \"Image ID or Digest\"\n properties:\n ID:\n type: \"string\"\n example:\n ID: \"sha256:85f05633ddc1c50679be2b16a0479ab6f7637f8884e0cfe0f4d20e1ebb3d6e7c\"\n\n CreateImageInfo:\n type: \"object\"\n properties:\n id:\n type: \"string\"\n error:\n type: \"string\"\n status:\n type: \"string\"\n progress:\n type: \"string\"\n progressDetail:\n $ref: \"#/definitions/ProgressDetail\"\n\n PushImageInfo:\n type: \"object\"\n properties:\n error:\n type: \"string\"\n status:\n type: \"string\"\n progress:\n type: \"string\"\n progressDetail:\n $ref: \"#/definitions/ProgressDetail\"\n\n ErrorDetail:\n type: \"object\"\n properties:\n code:\n type: \"integer\"\n message:\n type: \"string\"\n\n ProgressDetail:\n type: \"object\"\n properties:\n current:\n type: \"integer\"\n total:\n type: \"integer\"\n\n ErrorResponse:\n description: \"Represents an error.\"\n type: \"object\"\n required: [\"message\"]\n properties:\n message:\n description: \"The error message.\"\n type: \"string\"\n x-nullable: false\n example:\n message: \"Something went wrong.\"\n\n IdResponse:\n description: \"Response to an API call that returns just an Id\"\n type: \"object\"\n required: [\"Id\"]\n properties:\n Id:\n description: \"The id of the newly created object.\"\n type: \"string\"\n x-nullable: false\n\n EndpointSettings:\n description: \"Configuration for a network endpoint.\"\n type: \"object\"\n properties:\n # Configurations\n IPAMConfig:\n $ref: \"#/definitions/EndpointIPAMConfig\"\n Links:\n type: \"array\"\n items:\n type: \"string\"\n example:\n - \"container_1\"\n - \"container_2\"\n Aliases:\n type: \"array\"\n items:\n type: \"string\"\n example:\n - \"server_x\"\n - \"server_y\"\n\n # Operational data\n NetworkID:\n description: |\n Unique ID of the network.\n type: \"string\"\n example: \"08754567f1f40222263eab4102e1c733ae697e8e354aa9cd6e18d7402835292a\"\n EndpointID:\n description: |\n Unique ID for the service endpoint in a Sandbox.\n type: \"string\"\n example: \"b88f5b905aabf2893f3cbc4ee42d1ea7980bbc0a92e2c8922b1e1795298afb0b\"\n Gateway:\n description: |\n Gateway address for this network.\n type: \"string\"\n example: \"172.17.0.1\"\n IPAddress:\n description: |\n IPv4 address.\n type: \"string\"\n example: \"172.17.0.4\"\n IPPrefixLen:\n description: |\n Mask length of the IPv4 address.\n type: \"integer\"\n example: 16\n IPv6Gateway:\n description: |\n IPv6 gateway address.\n type: \"string\"\n example: \"2001:db8:2::100\"\n GlobalIPv6Address:\n description: |\n Global IPv6 address.\n type: \"string\"\n example: \"2001:db8::5689\"\n GlobalIPv6PrefixLen:\n description: |\n Mask length of the global IPv6 address.\n type: \"integer\"\n format: \"int64\"\n example: 64\n MacAddress:\n description: |\n MAC address for the endpoint on this network.\n type: \"string\"\n example: \"02:42:ac:11:00:04\"\n DriverOpts:\n description: |\n DriverOpts is a mapping of driver options and values. These options\n are passed directly to the driver and are driver specific.\n type: \"object\"\n x-nullable: true\n additionalProperties:\n type: \"string\"\n example:\n com.example.some-label: \"some-value\"\n com.example.some-other-label: \"some-other-value\"\n\n EndpointIPAMConfig:\n description: |\n EndpointIPAMConfig represents an endpoint's IPAM configuration.\n type: \"object\"\n x-nullable: true\n properties:\n IPv4Address:\n type: \"string\"\n example: \"172.20.30.33\"\n IPv6Address:\n type: \"string\"\n example: \"2001:db8:abcd::3033\"\n LinkLocalIPs:\n type: \"array\"\n items:\n type: \"string\"\n example:\n - \"169.254.34.68\"\n - \"fe80::3468\"\n\n PluginMount:\n type: \"object\"\n x-nullable: false\n required: [Name, Description, Settable, Source, Destination, Type, Options]\n properties:\n Name:\n type: \"string\"\n x-nullable: false\n example: \"some-mount\"\n Description:\n type: \"string\"\n x-nullable: false\n example: \"This is a mount that's used by the plugin.\"\n Settable:\n type: \"array\"\n items:\n type: \"string\"\n Source:\n type: \"string\"\n example: \"/var/lib/docker/plugins/\"\n Destination:\n type: \"string\"\n x-nullable: false\n example: \"/mnt/state\"\n Type:\n type: \"string\"\n x-nullable: false\n example: \"bind\"\n Options:\n type: \"array\"\n items:\n type: \"string\"\n example:\n - \"rbind\"\n - \"rw\"\n\n PluginDevice:\n type: \"object\"\n required: [Name, Description, Settable, Path]\n x-nullable: false\n properties:\n Name:\n type: \"string\"\n x-nullable: false\n Description:\n type: \"string\"\n x-nullable: false\n Settable:\n type: \"array\"\n items:\n type: \"string\"\n Path:\n type: \"string\"\n example: \"/dev/fuse\"\n\n PluginEnv:\n type: \"object\"\n x-nullable: false\n required: [Name, Description, Settable, Value]\n properties:\n Name:\n x-nullable: false\n type: \"string\"\n Description:\n x-nullable: false\n type: \"string\"\n Settable:\n type: \"array\"\n items:\n type: \"string\"\n Value:\n type: \"string\"\n\n PluginInterfaceType:\n type: \"object\"\n x-nullable: false\n required: [Prefix, Capability, Version]\n properties:\n Prefix:\n type: \"string\"\n x-nullable: false\n Capability:\n type: \"string\"\n x-nullable: false\n Version:\n type: \"string\"\n x-nullable: false\n\n PluginPrivilegeItem:\n description: |\n Describes a permission the user has to accept upon installing\n the plugin.\n type: \"object\"\n properties:\n Name:\n type: \"string\"\n example: \"network\"\n Description:\n type: \"string\"\n Value:\n type: \"array\"\n items:\n type: \"string\"\n example:\n - \"host\"\n\n Plugin:\n description: \"A plugin for the Engine API\"\n type: \"object\"\n required: [Settings, Enabled, Config, Name]\n properties:\n Id:\n type: \"string\"\n example: \"5724e2c8652da337ab2eedd19fc6fc0ec908e4bd907c7421bf6a8dfc70c4c078\"\n Name:\n type: \"string\"\n x-nullable: false\n example: \"tiborvass/sample-volume-plugin\"\n Enabled:\n description:\n True if the plugin is running. False if the plugin is not running,\n only installed.\n type: \"boolean\"\n x-nullable: false\n example: true\n Settings:\n description: \"Settings that can be modified by users.\"\n type: \"object\"\n x-nullable: false\n required: [Args, Devices, Env, Mounts]\n properties:\n Mounts:\n type: \"array\"\n items:\n $ref: \"#/definitions/PluginMount\"\n Env:\n type: \"array\"\n items:\n type: \"string\"\n example:\n - \"DEBUG=0\"\n Args:\n type: \"array\"\n items:\n type: \"string\"\n Devices:\n type: \"array\"\n items:\n $ref: \"#/definitions/PluginDevice\"\n PluginReference:\n description: \"plugin remote reference used to push/pull the plugin\"\n type: \"string\"\n x-nullable: false\n example: \"localhost:5000/tiborvass/sample-volume-plugin:latest\"\n Config:\n description: \"The config of a plugin.\"\n type: \"object\"\n x-nullable: false\n required:\n - Description\n - Documentation\n - Interface\n - Entrypoint\n - WorkDir\n - Network\n - Linux\n - PidHost\n - PropagatedMount\n - IpcHost\n - Mounts\n - Env\n - Args\n properties:\n DockerVersion:\n description: \"Docker Version used to create the plugin\"\n type: \"string\"\n x-nullable: false\n example: \"17.06.0-ce\"\n Description:\n type: \"string\"\n x-nullable: false\n example: \"A sample volume plugin for Docker\"\n Documentation:\n type: \"string\"\n x-nullable: false\n example: \"https://docs.docker.com/engine/extend/plugins/\"\n Interface:\n description: \"The interface between Docker and the plugin\"\n x-nullable: false\n type: \"object\"\n required: [Types, Socket]\n properties:\n Types:\n type: \"array\"\n items:\n $ref: \"#/definitions/PluginInterfaceType\"\n example:\n - \"docker.volumedriver/1.0\"\n Socket:\n type: \"string\"\n x-nullable: false\n example: \"plugins.sock\"\n ProtocolScheme:\n type: \"string\"\n example: \"some.protocol/v1.0\"\n description: \"Protocol to use for clients connecting to the plugin.\"\n enum:\n - \"\"\n - \"moby.plugins.http/v1\"\n Entrypoint:\n type: \"array\"\n items:\n type: \"string\"\n example:\n - \"/usr/bin/sample-volume-plugin\"\n - \"/data\"\n WorkDir:\n type: \"string\"\n x-nullable: false\n example: \"/bin/\"\n User:\n type: \"object\"\n x-nullable: false\n properties:\n UID:\n type: \"integer\"\n format: \"uint32\"\n example: 1000\n GID:\n type: \"integer\"\n format: \"uint32\"\n example: 1000\n Network:\n type: \"object\"\n x-nullable: false\n required: [Type]\n properties:\n Type:\n x-nullable: false\n type: \"string\"\n example: \"host\"\n Linux:\n type: \"object\"\n x-nullable: false\n required: [Capabilities, AllowAllDevices, Devices]\n properties:\n Capabilities:\n type: \"array\"\n items:\n type: \"string\"\n example:\n - \"CAP_SYS_ADMIN\"\n - \"CAP_SYSLOG\"\n AllowAllDevices:\n type: \"boolean\"\n x-nullable: false\n example: false\n Devices:\n type: \"array\"\n items:\n $ref: \"#/definitions/PluginDevice\"\n PropagatedMount:\n type: \"string\"\n x-nullable: false\n example: \"/mnt/volumes\"\n IpcHost:\n type: \"boolean\"\n x-nullable: false\n example: false\n PidHost:\n type: \"boolean\"\n x-nullable: false\n example: false\n Mounts:\n type: \"array\"\n items:\n $ref: \"#/definitions/PluginMount\"\n Env:\n type: \"array\"\n items:\n $ref: \"#/definitions/PluginEnv\"\n example:\n - Name: \"DEBUG\"\n Description: \"If set, prints debug messages\"\n Settable: null\n Value: \"0\"\n Args:\n type: \"object\"\n x-nullable: false\n required: [Name, Description, Settable, Value]\n properties:\n Name:\n x-nullable: false\n type: \"string\"\n example: \"args\"\n Description:\n x-nullable: false\n type: \"string\"\n example: \"command line arguments\"\n Settable:\n type: \"array\"\n items:\n type: \"string\"\n Value:\n type: \"array\"\n items:\n type: \"string\"\n rootfs:\n type: \"object\"\n properties:\n type:\n type: \"string\"\n example: \"layers\"\n diff_ids:\n type: \"array\"\n items:\n type: \"string\"\n example:\n - \"sha256:675532206fbf3030b8458f88d6e26d4eb1577688a25efec97154c94e8b6b4887\"\n - \"sha256:e216a057b1cb1efc11f8a268f37ef62083e70b1b38323ba252e25ac88904a7e8\"\n\n ObjectVersion:\n description: |\n The version number of the object such as node, service, etc. This is needed\n to avoid conflicting writes. The client must send the version number along\n with the modified specification when updating these objects.\n\n This approach ensures safe concurrency and determinism in that the change\n on the object may not be applied if the version number has changed from the\n last read. In other words, if two update requests specify the same base\n version, only one of the requests can succeed. As a result, two separate\n update requests that happen at the same time will not unintentionally\n overwrite each other.\n type: \"object\"\n properties:\n Index:\n type: \"integer\"\n format: \"uint64\"\n example: 373531\n\n NodeSpec:\n type: \"object\"\n properties:\n Name:\n description: \"Name for the node.\"\n type: \"string\"\n example: \"my-node\"\n Labels:\n description: \"User-defined key/value metadata.\"\n type: \"object\"\n additionalProperties:\n type: \"string\"\n Role:\n description: \"Role of the node.\"\n type: \"string\"\n enum:\n - \"worker\"\n - \"manager\"\n example: \"manager\"\n Availability:\n description: \"Availability of the node.\"\n type: \"string\"\n enum:\n - \"active\"\n - \"pause\"\n - \"drain\"\n example: \"active\"\n example:\n Availability: \"active\"\n Name: \"node-name\"\n Role: \"manager\"\n Labels:\n foo: \"bar\"\n\n Node:\n type: \"object\"\n properties:\n ID:\n type: \"string\"\n example: \"24ifsmvkjbyhk\"\n Version:\n $ref: \"#/definitions/ObjectVersion\"\n CreatedAt:\n description: |\n Date and time at which the node was added to the swarm in\n [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format with nano-seconds.\n type: \"string\"\n format: \"dateTime\"\n example: \"2016-08-18T10:44:24.496525531Z\"\n UpdatedAt:\n description: |\n Date and time at which the node was last updated in\n [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format with nano-seconds.\n type: \"string\"\n format: \"dateTime\"\n example: \"2017-08-09T07:09:37.632105588Z\"\n Spec:\n $ref: \"#/definitions/NodeSpec\"\n Description:\n $ref: \"#/definitions/NodeDescription\"\n Status:\n $ref: \"#/definitions/NodeStatus\"\n ManagerStatus:\n $ref: \"#/definitions/ManagerStatus\"\n\n NodeDescription:\n description: |\n NodeDescription encapsulates the properties of the Node as reported by the\n agent.\n type: \"object\"\n properties:\n Hostname:\n type: \"string\"\n example: \"bf3067039e47\"\n Platform:\n $ref: \"#/definitions/Platform\"\n Resources:\n $ref: \"#/definitions/ResourceObject\"\n Engine:\n $ref: \"#/definitions/EngineDescription\"\n TLSInfo:\n $ref: \"#/definitions/TLSInfo\"\n\n Platform:\n description: |\n Platform represents the platform (Arch/OS).\n type: \"object\"\n properties:\n Architecture:\n description: |\n Architecture represents the hardware architecture (for example,\n `x86_64`).\n type: \"string\"\n example: \"x86_64\"\n OS:\n description: |\n OS represents the Operating System (for example, `linux` or `windows`).\n type: \"string\"\n example: \"linux\"\n\n EngineDescription:\n description: \"EngineDescription provides information about an engine.\"\n type: \"object\"\n properties:\n EngineVersion:\n type: \"string\"\n example: \"17.06.0\"\n Labels:\n type: \"object\"\n additionalProperties:\n type: \"string\"\n example:\n foo: \"bar\"\n Plugins:\n type: \"array\"\n items:\n type: \"object\"\n properties:\n Type:\n type: \"string\"\n Name:\n type: \"string\"\n example:\n - Type: \"Log\"\n Name: \"awslogs\"\n - Type: \"Log\"\n Name: \"fluentd\"\n - Type: \"Log\"\n Name: \"gcplogs\"\n - Type: \"Log\"\n Name: \"gelf\"\n - Type: \"Log\"\n Name: \"journald\"\n - Type: \"Log\"\n Name: \"json-file\"\n - Type: \"Log\"\n Name: \"logentries\"\n - Type: \"Log\"\n Name: \"splunk\"\n - Type: \"Log\"\n Name: \"syslog\"\n - Type: \"Network\"\n Name: \"bridge\"\n - Type: \"Network\"\n Name: \"host\"\n - Type: \"Network\"\n Name: \"ipvlan\"\n - Type: \"Network\"\n Name: \"macvlan\"\n - Type: \"Network\"\n Name: \"null\"\n - Type: \"Network\"\n Name: \"overlay\"\n - Type: \"Volume\"\n Name: \"local\"\n - Type: \"Volume\"\n Name: \"localhost:5000/vieux/sshfs:latest\"\n - Type: \"Volume\"\n Name: \"vieux/sshfs:latest\"\n\n TLSInfo:\n description: |\n Information about the issuer of leaf TLS certificates and the trusted root\n CA certificate.\n type: \"object\"\n properties:\n TrustRoot:\n description: |\n The root CA certificate(s) that are used to validate leaf TLS\n certificates.\n type: \"string\"\n CertIssuerSubject:\n description:\n The base64-url-safe-encoded raw subject bytes of the issuer.\n type: \"string\"\n CertIssuerPublicKey:\n description: |\n The base64-url-safe-encoded raw public key bytes of the issuer.\n type: \"string\"\n example:\n TrustRoot: |\n -----BEGIN CERTIFICATE-----\n MIIBajCCARCgAwIBAgIUbYqrLSOSQHoxD8CwG6Bi2PJi9c8wCgYIKoZIzj0EAwIw\n EzERMA8GA1UEAxMIc3dhcm0tY2EwHhcNMTcwNDI0MjE0MzAwWhcNMzcwNDE5MjE0\n MzAwWjATMREwDwYDVQQDEwhzd2FybS1jYTBZMBMGByqGSM49AgEGCCqGSM49AwEH\n A0IABJk/VyMPYdaqDXJb/VXh5n/1Yuv7iNrxV3Qb3l06XD46seovcDWs3IZNV1lf\n 3Skyr0ofcchipoiHkXBODojJydSjQjBAMA4GA1UdDwEB/wQEAwIBBjAPBgNVHRMB\n Af8EBTADAQH/MB0GA1UdDgQWBBRUXxuRcnFjDfR/RIAUQab8ZV/n4jAKBggqhkjO\n PQQDAgNIADBFAiAy+JTe6Uc3KyLCMiqGl2GyWGQqQDEcO3/YG36x7om65AIhAJvz\n pxv6zFeVEkAEEkqIYi0omA9+CjanB/6Bz4n1uw8H\n -----END CERTIFICATE-----\n CertIssuerSubject: \"MBMxETAPBgNVBAMTCHN3YXJtLWNh\"\n CertIssuerPublicKey: \"MFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEmT9XIw9h1qoNclv9VeHmf/Vi6/uI2vFXdBveXTpcPjqx6i9wNazchk1XWV/dKTKvSh9xyGKmiIeRcE4OiMnJ1A==\"\n\n NodeStatus:\n description: |\n NodeStatus represents the status of a node.\n\n It provides the current status of the node, as seen by the manager.\n type: \"object\"\n properties:\n State:\n $ref: \"#/definitions/NodeState\"\n Message:\n type: \"string\"\n example: \"\"\n Addr:\n description: \"IP address of the node.\"\n type: \"string\"\n example: \"172.17.0.2\"\n\n NodeState:\n description: \"NodeState represents the state of a node.\"\n type: \"string\"\n enum:\n - \"unknown\"\n - \"down\"\n - \"ready\"\n - \"disconnected\"\n example: \"ready\"\n\n ManagerStatus:\n description: |\n ManagerStatus represents the status of a manager.\n\n It provides the current status of a node's manager component, if the node\n is a manager.\n x-nullable: true\n type: \"object\"\n properties:\n Leader:\n type: \"boolean\"\n default: false\n example: true\n Reachability:\n $ref: \"#/definitions/Reachability\"\n Addr:\n description: |\n The IP address and port at which the manager is reachable.\n type: \"string\"\n example: \"10.0.0.46:2377\"\n\n Reachability:\n description: \"Reachability represents the reachability of a node.\"\n type: \"string\"\n enum:\n - \"unknown\"\n - \"unreachable\"\n - \"reachable\"\n example: \"reachable\"\n\n SwarmSpec:\n description: \"User modifiable swarm configuration.\"\n type: \"object\"\n properties:\n Name:\n description: \"Name of the swarm.\"\n type: \"string\"\n example: \"default\"\n Labels:\n description: \"User-defined key/value metadata.\"\n type: \"object\"\n additionalProperties:\n type: \"string\"\n example:\n com.example.corp.type: \"production\"\n com.example.corp.department: \"engineering\"\n Orchestration:\n description: \"Orchestration configuration.\"\n type: \"object\"\n x-nullable: true\n properties:\n TaskHistoryRetentionLimit:\n description: |\n The number of historic tasks to keep per instance or node. If\n negative, never remove completed or failed tasks.\n type: \"integer\"\n format: \"int64\"\n example: 10\n Raft:\n description: \"Raft configuration.\"\n type: \"object\"\n properties:\n SnapshotInterval:\n description: \"The number of log entries between snapshots.\"\n type: \"integer\"\n format: \"uint64\"\n example: 10000\n KeepOldSnapshots:\n description: |\n The number of snapshots to keep beyond the current snapshot.\n type: \"integer\"\n format: \"uint64\"\n LogEntriesForSlowFollowers:\n description: |\n The number of log entries to keep around to sync up slow followers\n after a snapshot is created.\n type: \"integer\"\n format: \"uint64\"\n example: 500\n ElectionTick:\n description: |\n The number of ticks that a follower will wait for a message from\n the leader before becoming a candidate and starting an election.\n `ElectionTick` must be greater than `HeartbeatTick`.\n\n A tick currently defaults to one second, so these translate\n directly to seconds currently, but this is NOT guaranteed.\n type: \"integer\"\n example: 3\n HeartbeatTick:\n description: |\n The number of ticks between heartbeats. Every HeartbeatTick ticks,\n the leader will send a heartbeat to the followers.\n\n A tick currently defaults to one second, so these translate\n directly to seconds currently, but this is NOT guaranteed.\n type: \"integer\"\n example: 1\n Dispatcher:\n description: \"Dispatcher configuration.\"\n type: \"object\"\n x-nullable: true\n properties:\n HeartbeatPeriod:\n description: |\n The delay for an agent to send a heartbeat to the dispatcher.\n type: \"integer\"\n format: \"int64\"\n example: 5000000000\n CAConfig:\n description: \"CA configuration.\"\n type: \"object\"\n x-nullable: true\n properties:\n NodeCertExpiry:\n description: \"The duration node certificates are issued for.\"\n type: \"integer\"\n format: \"int64\"\n example: 7776000000000000\n ExternalCAs:\n description: |\n Configuration for forwarding signing requests to an external\n certificate authority.\n type: \"array\"\n items:\n type: \"object\"\n properties:\n Protocol:\n description: |\n Protocol for communication with the external CA (currently\n only `cfssl` is supported).\n type: \"string\"\n enum:\n - \"cfssl\"\n default: \"cfssl\"\n URL:\n description: |\n URL where certificate signing requests should be sent.\n type: \"string\"\n Options:\n description: |\n An object with key/value pairs that are interpreted as\n protocol-specific options for the external CA driver.\n type: \"object\"\n additionalProperties:\n type: \"string\"\n CACert:\n description: |\n The root CA certificate (in PEM format) this external CA uses\n to issue TLS certificates (assumed to be to the current swarm\n root CA certificate if not provided).\n type: \"string\"\n SigningCACert:\n description: |\n The desired signing CA certificate for all swarm node TLS leaf\n certificates, in PEM format.\n type: \"string\"\n SigningCAKey:\n description: |\n The desired signing CA key for all swarm node TLS leaf certificates,\n in PEM format.\n type: \"string\"\n ForceRotate:\n description: |\n An integer whose purpose is to force swarm to generate a new\n signing CA certificate and key, if none have been specified in\n `SigningCACert` and `SigningCAKey`\n format: \"uint64\"\n type: \"integer\"\n EncryptionConfig:\n description: \"Parameters related to encryption-at-rest.\"\n type: \"object\"\n properties:\n AutoLockManagers:\n description: |\n If set, generate a key and use it to lock data stored on the\n managers.\n type: \"boolean\"\n example: false\n TaskDefaults:\n description: \"Defaults for creating tasks in this cluster.\"\n type: \"object\"\n properties:\n LogDriver:\n description: |\n The log driver to use for tasks created in the orchestrator if\n unspecified by a service.\n\n Updating this value only affects new tasks. Existing tasks continue\n to use their previously configured log driver until recreated.\n type: \"object\"\n properties:\n Name:\n description: |\n The log driver to use as a default for new tasks.\n type: \"string\"\n example: \"json-file\"\n Options:\n description: |\n Driver-specific options for the selectd log driver, specified\n as key/value pairs.\n type: \"object\"\n additionalProperties:\n type: \"string\"\n example:\n \"max-file\": \"10\"\n \"max-size\": \"100m\"\n\n # The Swarm information for `GET /info`. It is the same as `GET /swarm`, but\n # without `JoinTokens`.\n ClusterInfo:\n description: |\n ClusterInfo represents information about the swarm as is returned by the\n \"/info\" endpoint. Join-tokens are not included.\n x-nullable: true\n type: \"object\"\n properties:\n ID:\n description: \"The ID of the swarm.\"\n type: \"string\"\n example: \"abajmipo7b4xz5ip2nrla6b11\"\n Version:\n $ref: \"#/definitions/ObjectVersion\"\n CreatedAt:\n description: |\n Date and time at which the swarm was initialised in\n [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format with nano-seconds.\n type: \"string\"\n format: \"dateTime\"\n example: \"2016-08-18T10:44:24.496525531Z\"\n UpdatedAt:\n description: |\n Date and time at which the swarm was last updated in\n [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format with nano-seconds.\n type: \"string\"\n format: \"dateTime\"\n example: \"2017-08-09T07:09:37.632105588Z\"\n Spec:\n $ref: \"#/definitions/SwarmSpec\"\n TLSInfo:\n $ref: \"#/definitions/TLSInfo\"\n RootRotationInProgress:\n description: |\n Whether there is currently a root CA rotation in progress for the swarm\n type: \"boolean\"\n example: false\n DataPathPort:\n description: |\n DataPathPort specifies the data path port number for data traffic.\n Acceptable port range is 1024 to 49151.\n If no port is set or is set to 0, the default port (4789) is used.\n type: \"integer\"\n format: \"uint32\"\n default: 4789\n example: 4789\n DefaultAddrPool:\n description: |\n Default Address Pool specifies default subnet pools for global scope\n networks.\n type: \"array\"\n items:\n type: \"string\"\n format: \"CIDR\"\n example: [\"10.10.0.0/16\", \"20.20.0.0/16\"]\n SubnetSize:\n description: |\n SubnetSize specifies the subnet size of the networks created from the\n default subnet pool.\n type: \"integer\"\n format: \"uint32\"\n maximum: 29\n default: 24\n example: 24\n\n JoinTokens:\n description: |\n JoinTokens contains the tokens workers and managers need to join the swarm.\n type: \"object\"\n properties:\n Worker:\n description: |\n The token workers can use to join the swarm.\n type: \"string\"\n example: \"SWMTKN-1-3pu6hszjas19xyp7ghgosyx9k8atbfcr8p2is99znpy26u2lkl-1awxwuwd3z9j1z3puu7rcgdbx\"\n Manager:\n description: |\n The token managers can use to join the swarm.\n type: \"string\"\n example: \"SWMTKN-1-3pu6hszjas19xyp7ghgosyx9k8atbfcr8p2is99znpy26u2lkl-7p73s1dx5in4tatdymyhg9hu2\"\n\n Swarm:\n type: \"object\"\n allOf:\n - $ref: \"#/definitions/ClusterInfo\"\n - type: \"object\"\n properties:\n JoinTokens:\n $ref: \"#/definitions/JoinTokens\"\n\n TaskSpec:\n description: \"User modifiable task configuration.\"\n type: \"object\"\n properties:\n PluginSpec:\n type: \"object\"\n description: |\n Plugin spec for the service. *(Experimental release only.)*\n\n [:]` or `[:]`.\n\n Some images (for example, Windows base images) contain artifacts\n whose distribution is restricted by license. When these images are\n pushed to a registry, restricted artifacts are not included.\n\n This configuration override this behavior for the specified\n registries.\n\n This option is useful when pushing images containing\n nondistributable artifacts to a registry on an air-gapped network so\n hosts on that network can pull the images without connecting to\n another server.\n\n > **Warning**: Nondistributable artifacts typically have restrictions\n > on how and where they can be distributed and shared. Only use this\n > feature to push artifacts to private registries and ensure that you\n > are in compliance with any terms that cover redistributing\n > nondistributable artifacts.\n type: \"array\"\n items:\n type: \"string\"\n example: [\"registry.internal.corp.example.com:3000\", \"[2001:db8:a0b:12f0::1]:443\"]\n InsecureRegistryCIDRs:\n description: |\n List of IP ranges of insecure registries, using the CIDR syntax\n ([RFC 4632](https://tools.ietf.org/html/4632)). Insecure registries\n accept un-encrypted (HTTP) and/or untrusted (HTTPS with certificates\n from unknown CAs) communication.\n\n By default, local registries (`127.0.0.0/8`) are configured as\n insecure. All other registries are secure. Communicating with an\n insecure registry is not possible if the daemon assumes that registry\n is secure.\n\n This configuration override this behavior, insecure communication with\n registries whose resolved IP address is within the subnet described by\n the CIDR syntax.\n\n Registries can also be marked insecure by hostname. Those registries\n are listed under `IndexConfigs` and have their `Secure` field set to\n `false`.\n\n > **Warning**: Using this option can be useful when running a local\n > registry, but introduces security vulnerabilities. This option\n > should therefore ONLY be used for testing purposes. For increased\n > security, users should add their CA to their system's list of trusted\n > CAs instead of enabling this option.\n type: \"array\"\n items:\n type: \"string\"\n example: [\"::1/128\", \"127.0.0.0/8\"]\n IndexConfigs:\n type: \"object\"\n additionalProperties:\n $ref: \"#/definitions/IndexInfo\"\n example:\n \"127.0.0.1:5000\":\n \"Name\": \"127.0.0.1:5000\"\n \"Mirrors\": []\n \"Secure\": false\n \"Official\": false\n \"[2001:db8:a0b:12f0::1]:80\":\n \"Name\": \"[2001:db8:a0b:12f0::1]:80\"\n \"Mirrors\": []\n \"Secure\": false\n \"Official\": false\n \"docker.io\":\n Name: \"docker.io\"\n Mirrors: [\"https://hub-mirror.corp.example.com:5000/\"]\n Secure: true\n Official: true\n \"registry.internal.corp.example.com:3000\":\n Name: \"registry.internal.corp.example.com:3000\"\n Mirrors: []\n Secure: false\n Official: false\n Mirrors:\n description: |\n List of registry URLs that act as a mirror for the official\n (`docker.io`) registry.\n\n type: \"array\"\n items:\n type: \"string\"\n example:\n - \"https://hub-mirror.corp.example.com:5000/\"\n - \"https://[2001:db8:a0b:12f0::1]/\"\n\n IndexInfo:\n description:\n IndexInfo contains information about a registry.\n type: \"object\"\n x-nullable: true\n properties:\n Name:\n description: |\n Name of the registry, such as \"docker.io\".\n type: \"string\"\n example: \"docker.io\"\n Mirrors:\n description: |\n List of mirrors, expressed as URIs.\n type: \"array\"\n items:\n type: \"string\"\n example:\n - \"https://hub-mirror.corp.example.com:5000/\"\n - \"https://registry-2.docker.io/\"\n - \"https://registry-3.docker.io/\"\n Secure:\n description: |\n Indicates if the registry is part of the list of insecure\n registries.\n\n If `false`, the registry is insecure. Insecure registries accept\n un-encrypted (HTTP) and/or untrusted (HTTPS with certificates from\n unknown CAs) communication.\n\n > **Warning**: Insecure registries can be useful when running a local\n > registry. However, because its use creates security vulnerabilities\n > it should ONLY be enabled for testing purposes. For increased\n > security, users should add their CA to their system's list of\n > trusted CAs instead of enabling this option.\n type: \"boolean\"\n example: true\n Official:\n description: |\n Indicates whether this is an official registry (i.e., Docker Hub / docker.io)\n type: \"boolean\"\n example: true\n\n Runtime:\n description: |\n Runtime describes an [OCI compliant](https://github.com/opencontainers/runtime-spec)\n runtime.\n\n The runtime is invoked by the daemon via the `containerd` daemon. OCI\n runtimes act as an interface to the Linux kernel namespaces, cgroups,\n and SELinux.\n type: \"object\"\n properties:\n path:\n description: |\n Name and, optional, path, of the OCI executable binary.\n\n If the path is omitted, the daemon searches the host's `$PATH` for the\n binary and uses the first result.\n type: \"string\"\n example: \"/usr/local/bin/my-oci-runtime\"\n runtimeArgs:\n description: |\n List of command-line arguments to pass to the runtime when invoked.\n type: \"array\"\n x-nullable: true\n items:\n type: \"string\"\n example: [\"--debug\", \"--systemd-cgroup=false\"]\n\n Commit:\n description: |\n Commit holds the Git-commit (SHA1) that a binary was built from, as\n reported in the version-string of external tools, such as `containerd`,\n or `runC`.\n type: \"object\"\n properties:\n ID:\n description: \"Actual commit ID of external tool.\"\n type: \"string\"\n example: \"cfb82a876ecc11b5ca0977d1733adbe58599088a\"\n Expected:\n description: |\n Commit ID of external tool expected by dockerd as set at build time.\n type: \"string\"\n example: \"2d41c047c83e09a6d61d464906feb2a2f3c52aa4\"\n\n SwarmInfo:\n description: |\n Represents generic information about swarm.\n type: \"object\"\n properties:\n NodeID:\n description: \"Unique identifier of for this node in the swarm.\"\n type: \"string\"\n default: \"\"\n example: \"k67qz4598weg5unwwffg6z1m1\"\n NodeAddr:\n description: |\n IP address at which this node can be reached by other nodes in the\n swarm.\n type: \"string\"\n default: \"\"\n example: \"10.0.0.46\"\n LocalNodeState:\n $ref: \"#/definitions/LocalNodeState\"\n ControlAvailable:\n type: \"boolean\"\n default: false\n example: true\n Error:\n type: \"string\"\n default: \"\"\n RemoteManagers:\n description: |\n List of ID's and addresses of other managers in the swarm.\n type: \"array\"\n default: null\n x-nullable: true\n items:\n $ref: \"#/definitions/PeerNode\"\n example:\n - NodeID: \"71izy0goik036k48jg985xnds\"\n Addr: \"10.0.0.158:2377\"\n - NodeID: \"79y6h1o4gv8n120drcprv5nmc\"\n Addr: \"10.0.0.159:2377\"\n - NodeID: \"k67qz4598weg5unwwffg6z1m1\"\n Addr: \"10.0.0.46:2377\"\n Nodes:\n description: \"Total number of nodes in the swarm.\"\n type: \"integer\"\n x-nullable: true\n example: 4\n Managers:\n description: \"Total number of managers in the swarm.\"\n type: \"integer\"\n x-nullable: true\n example: 3\n Cluster:\n $ref: \"#/definitions/ClusterInfo\"\n\n LocalNodeState:\n description: \"Current local status of this node.\"\n type: \"string\"\n default: \"\"\n enum:\n - \"\"\n - \"inactive\"\n - \"pending\"\n - \"active\"\n - \"error\"\n - \"locked\"\n example: \"active\"\n\n PeerNode:\n description: \"Represents a peer-node in the swarm\"\n properties:\n NodeID:\n description: \"Unique identifier of for this node in the swarm.\"\n type: \"string\"\n Addr:\n description: |\n IP address and ports at which this node can be reached.\n type: \"string\"\n\n NetworkAttachmentConfig:\n description: |\n Specifies how a service should be attached to a particular network.\n type: \"object\"\n properties:\n Target:\n description: |\n The target network for attachment. Must be a network name or ID.\n type: \"string\"\n Aliases:\n description: |\n Discoverable alternate names for the service on this network.\n type: \"array\"\n items:\n type: \"string\"\n DriverOpts:\n description: |\n Driver attachment options for the network target.\n type: \"object\"\n additionalProperties:\n type: \"string\"\n\npaths:\n /containers/json:\n get:\n summary: \"List containers\"\n description: |\n Returns a list of containers. For details on the format, see the\n [inspect endpoint](#operation/ContainerInspect).\n\n Note that it uses a different, smaller representation of a container\n than inspecting a single container. For example, the list of linked\n containers is not propagated .\n operationId: \"ContainerList\"\n produces:\n - \"application/json\"\n parameters:\n - name: \"all\"\n in: \"query\"\n description: |\n Return all containers. By default, only running containers are shown.\n type: \"boolean\"\n default: false\n - name: \"limit\"\n in: \"query\"\n description: |\n Return this number of most recently created containers, including\n non-running ones.\n type: \"integer\"\n - name: \"size\"\n in: \"query\"\n description: |\n Return the size of container as fields `SizeRw` and `SizeRootFs`.\n type: \"boolean\"\n default: false\n - name: \"filters\"\n in: \"query\"\n description: |\n Filters to process on the container list, encoded as JSON (a\n `map[string][]string`). For example, `{\"status\": [\"paused\"]}` will\n only return paused containers.\n\n Available filters:\n\n - `ancestor`=(`[:]`, ``, or ``)\n - `before`=(`` or ``)\n - `expose`=(`[/]`|`/[]`)\n - `exited=` containers with exit code of ``\n - `health`=(`starting`|`healthy`|`unhealthy`|`none`)\n - `id=` a container's ID\n - `isolation=`(`default`|`process`|`hyperv`) (Windows daemon only)\n - `is-task=`(`true`|`false`)\n - `label=key` or `label=\"key=value\"` of a container label\n - `name=` a container's name\n - `network`=(`` or ``)\n - `publish`=(`[/]`|`/[]`)\n - `since`=(`` or ``)\n - `status=`(`created`|`restarting`|`running`|`removing`|`paused`|`exited`|`dead`)\n - `volume`=(`` or ``)\n type: \"string\"\n responses:\n 200:\n description: \"no error\"\n schema:\n type: \"array\"\n items:\n $ref: \"#/definitions/ContainerSummary\"\n examples:\n application/json:\n - Id: \"8dfafdbc3a40\"\n Names:\n - \"/boring_feynman\"\n Image: \"ubuntu:latest\"\n ImageID: \"d74508fb6632491cea586a1fd7d748dfc5274cd6fdfedee309ecdcbc2bf5cb82\"\n Command: \"echo 1\"\n Created: 1367854155\n State: \"Exited\"\n Status: \"Exit 0\"\n Ports:\n - PrivatePort: 2222\n PublicPort: 3333\n Type: \"tcp\"\n Labels:\n com.example.vendor: \"Acme\"\n com.example.license: \"GPL\"\n com.example.version: \"1.0\"\n SizeRw: 12288\n SizeRootFs: 0\n HostConfig:\n NetworkMode: \"default\"\n NetworkSettings:\n Networks:\n bridge:\n NetworkID: \"7ea29fc1412292a2d7bba362f9253545fecdfa8ce9a6e37dd10ba8bee7129812\"\n EndpointID: \"2cdc4edb1ded3631c81f57966563e5c8525b81121bb3706a9a9a3ae102711f3f\"\n Gateway: \"172.17.0.1\"\n IPAddress: \"172.17.0.2\"\n IPPrefixLen: 16\n IPv6Gateway: \"\"\n GlobalIPv6Address: \"\"\n GlobalIPv6PrefixLen: 0\n MacAddress: \"02:42:ac:11:00:02\"\n Mounts:\n - Name: \"fac362...80535\"\n Source: \"/data\"\n Destination: \"/data\"\n Driver: \"local\"\n Mode: \"ro,Z\"\n RW: false\n Propagation: \"\"\n - Id: \"9cd87474be90\"\n Names:\n - \"/coolName\"\n Image: \"ubuntu:latest\"\n ImageID: \"d74508fb6632491cea586a1fd7d748dfc5274cd6fdfedee309ecdcbc2bf5cb82\"\n Command: \"echo 222222\"\n Created: 1367854155\n State: \"Exited\"\n Status: \"Exit 0\"\n Ports: []\n Labels: {}\n SizeRw: 12288\n SizeRootFs: 0\n HostConfig:\n NetworkMode: \"default\"\n NetworkSettings:\n Networks:\n bridge:\n NetworkID: \"7ea29fc1412292a2d7bba362f9253545fecdfa8ce9a6e37dd10ba8bee7129812\"\n EndpointID: \"88eaed7b37b38c2a3f0c4bc796494fdf51b270c2d22656412a2ca5d559a64d7a\"\n Gateway: \"172.17.0.1\"\n IPAddress: \"172.17.0.8\"\n IPPrefixLen: 16\n IPv6Gateway: \"\"\n GlobalIPv6Address: \"\"\n GlobalIPv6PrefixLen: 0\n MacAddress: \"02:42:ac:11:00:08\"\n Mounts: []\n - Id: \"3176a2479c92\"\n Names:\n - \"/sleepy_dog\"\n Image: \"ubuntu:latest\"\n ImageID: \"d74508fb6632491cea586a1fd7d748dfc5274cd6fdfedee309ecdcbc2bf5cb82\"\n Command: \"echo 3333333333333333\"\n Created: 1367854154\n State: \"Exited\"\n Status: \"Exit 0\"\n Ports: []\n Labels: {}\n SizeRw: 12288\n SizeRootFs: 0\n HostConfig:\n NetworkMode: \"default\"\n NetworkSettings:\n Networks:\n bridge:\n NetworkID: \"7ea29fc1412292a2d7bba362f9253545fecdfa8ce9a6e37dd10ba8bee7129812\"\n EndpointID: \"8b27c041c30326d59cd6e6f510d4f8d1d570a228466f956edf7815508f78e30d\"\n Gateway: \"172.17.0.1\"\n IPAddress: \"172.17.0.6\"\n IPPrefixLen: 16\n IPv6Gateway: \"\"\n GlobalIPv6Address: \"\"\n GlobalIPv6PrefixLen: 0\n MacAddress: \"02:42:ac:11:00:06\"\n Mounts: []\n - Id: \"4cb07b47f9fb\"\n Names:\n - \"/running_cat\"\n Image: \"ubuntu:latest\"\n ImageID: \"d74508fb6632491cea586a1fd7d748dfc5274cd6fdfedee309ecdcbc2bf5cb82\"\n Command: \"echo 444444444444444444444444444444444\"\n Created: 1367854152\n State: \"Exited\"\n Status: \"Exit 0\"\n Ports: []\n Labels: {}\n SizeRw: 12288\n SizeRootFs: 0\n HostConfig:\n NetworkMode: \"default\"\n NetworkSettings:\n Networks:\n bridge:\n NetworkID: \"7ea29fc1412292a2d7bba362f9253545fecdfa8ce9a6e37dd10ba8bee7129812\"\n EndpointID: \"d91c7b2f0644403d7ef3095985ea0e2370325cd2332ff3a3225c4247328e66e9\"\n Gateway: \"172.17.0.1\"\n IPAddress: \"172.17.0.5\"\n IPPrefixLen: 16\n IPv6Gateway: \"\"\n GlobalIPv6Address: \"\"\n GlobalIPv6PrefixLen: 0\n MacAddress: \"02:42:ac:11:00:05\"\n Mounts: []\n 400:\n description: \"bad parameter\"\n schema:\n $ref: \"#/definitions/ErrorResponse\"\n 500:\n description: \"server error\"\n schema:\n $ref: \"#/definitions/ErrorResponse\"\n tags: [\"Container\"]\n /containers/create:\n post:\n summary: \"Create a container\"\n operationId: \"ContainerCreate\"\n consumes:\n - \"application/json\"\n - \"application/octet-stream\"\n produces:\n - \"application/json\"\n parameters:\n - name: \"name\"\n in: \"query\"\n description: |\n Assign the specified name to the container. Must match\n `/?[a-zA-Z0-9][a-zA-Z0-9_.-]+`.\n type: \"string\"\n pattern: \"^/?[a-zA-Z0-9][a-zA-Z0-9_.-]+$\"\n - name: \"body\"\n in: \"body\"\n description: \"Container to create\"\n schema:\n allOf:\n - $ref: \"#/definitions/ContainerConfig\"\n - type: \"object\"\n properties:\n HostConfig:\n $ref: \"#/definitions/HostConfig\"\n NetworkingConfig:\n $ref: \"#/definitions/NetworkingConfig\"\n example:\n Hostname: \"\"\n Domainname: \"\"\n User: \"\"\n AttachStdin: false\n AttachStdout: true\n AttachStderr: true\n Tty: false\n OpenStdin: false\n StdinOnce: false\n Env:\n - \"FOO=bar\"\n - \"BAZ=quux\"\n Cmd:\n - \"date\"\n Entrypoint: \"\"\n Image: \"ubuntu\"\n Labels:\n com.example.vendor: \"Acme\"\n com.example.license: \"GPL\"\n com.example.version: \"1.0\"\n Volumes:\n /volumes/data: {}\n WorkingDir: \"\"\n NetworkDisabled: false\n MacAddress: \"12:34:56:78:9a:bc\"\n ExposedPorts:\n 22/tcp: {}\n StopSignal: \"SIGTERM\"\n StopTimeout: 10\n HostConfig:\n Binds:\n - \"/tmp:/tmp\"\n Links:\n - \"redis3:redis\"\n Memory: 0\n MemorySwap: 0\n MemoryReservation: 0\n KernelMemory: 0\n NanoCpus: 500000\n CpuPercent: 80\n CpuShares: 512\n CpuPeriod: 100000\n CpuRealtimePeriod: 1000000\n CpuRealtimeRuntime: 10000\n CpuQuota: 50000\n CpusetCpus: \"0,1\"\n CpusetMems: \"0,1\"\n MaximumIOps: 0\n MaximumIOBps: 0\n BlkioWeight: 300\n BlkioWeightDevice:\n - {}\n BlkioDeviceReadBps:\n - {}\n BlkioDeviceReadIOps:\n - {}\n BlkioDeviceWriteBps:\n - {}\n BlkioDeviceWriteIOps:\n - {}\n DeviceRequests:\n - Driver: \"nvidia\"\n Count: -1\n DeviceIDs\": [\"0\", \"1\", \"GPU-fef8089b-4820-abfc-e83e-94318197576e\"]\n Capabilities: [[\"gpu\", \"nvidia\", \"compute\"]]\n Options:\n property1: \"string\"\n property2: \"string\"\n MemorySwappiness: 60\n OomKillDisable: false\n OomScoreAdj: 500\n PidMode: \"\"\n PidsLimit: 0\n PortBindings:\n 22/tcp:\n - HostPort: \"11022\"\n PublishAllPorts: false\n Privileged: false\n ReadonlyRootfs: false\n Dns:\n - \"8.8.8.8\"\n DnsOptions:\n - \"\"\n DnsSearch:\n - \"\"\n VolumesFrom:\n - \"parent\"\n - \"other:ro\"\n CapAdd:\n - \"NET_ADMIN\"\n CapDrop:\n - \"MKNOD\"\n GroupAdd:\n - \"newgroup\"\n RestartPolicy:\n Name: \"\"\n MaximumRetryCount: 0\n AutoRemove: true\n NetworkMode: \"bridge\"\n Devices: []\n Ulimits:\n - {}\n LogConfig:\n Type: \"json-file\"\n Config: {}\n SecurityOpt: []\n StorageOpt: {}\n CgroupParent: \"\"\n VolumeDriver: \"\"\n ShmSize: 67108864\n NetworkingConfig:\n EndpointsConfig:\n isolated_nw:\n IPAMConfig:\n IPv4Address: \"172.20.30.33\"\n IPv6Address: \"2001:db8:abcd::3033\"\n LinkLocalIPs:\n - \"169.254.34.68\"\n - \"fe80::3468\"\n Links:\n - \"container_1\"\n - \"container_2\"\n Aliases:\n - \"server_x\"\n - \"server_y\"\n\n required: true\n responses:\n 201:\n description: \"Container created successfully\"\n schema:\n type: \"object\"\n title: \"ContainerCreateResponse\"\n description: \"OK response to ContainerCreate operation\"\n required: [Id, Warnings]\n properties:\n Id:\n description: \"The ID of the created container\"\n type: \"string\"\n x-nullable: false\n Warnings:\n description: \"Warnings encountered when creating the container\"\n type: \"array\"\n x-nullable: false\n items:\n type: \"string\"\n examples:\n application/json:\n Id: \"e90e34656806\"\n Warnings: []\n 400:\n description: \"bad parameter\"\n schema:\n $ref: \"#/definitions/ErrorResponse\"\n 404:\n description: \"no such image\"\n schema:\n $ref: \"#/definitions/ErrorResponse\"\n examples:\n application/json:\n message: \"No such image: c2ada9df5af8\"\n 409:\n description: \"conflict\"\n schema:\n $ref: \"#/definitions/ErrorResponse\"\n 500:\n description: \"server error\"\n schema:\n $ref: \"#/definitions/ErrorResponse\"\n tags: [\"Container\"]\n /containers/{id}/json:\n get:\n summary: \"Inspect a container\"\n description: \"Return low-level information about a container.\"\n operationId: \"ContainerInspect\"\n produces:\n - \"application/json\"\n responses:\n 200:\n description: \"no error\"\n schema:\n type: \"object\"\n title: \"ContainerInspectResponse\"\n properties:\n Id:\n description: \"The ID of the container\"\n type: \"string\"\n Created:\n description: \"The time the container was created\"\n type: \"string\"\n Path:\n description: \"The path to the command being run\"\n type: \"string\"\n Args:\n description: \"The arguments to the command being run\"\n type: \"array\"\n items:\n type: \"string\"\n State:\n x-nullable: true\n $ref: \"#/definitions/ContainerState\"\n Image:\n description: \"The container's image ID\"\n type: \"string\"\n ResolvConfPath:\n type: \"string\"\n HostnamePath:\n type: \"string\"\n HostsPath:\n type: \"string\"\n LogPath:\n type: \"string\"\n Name:\n type: \"string\"\n RestartCount:\n type: \"integer\"\n Driver:\n type: \"string\"\n Platform:\n type: \"string\"\n MountLabel:\n type: \"string\"\n ProcessLabel:\n type: \"string\"\n AppArmorProfile:\n type: \"string\"\n ExecIDs:\n description: \"IDs of exec instances that are running in the container.\"\n type: \"array\"\n items:\n type: \"string\"\n x-nullable: true\n HostConfig:\n $ref: \"#/definitions/HostConfig\"\n GraphDriver:\n $ref: \"#/definitions/GraphDriverData\"\n SizeRw:\n description: |\n The size of files that have been created or changed by this\n container.\n type: \"integer\"\n format: \"int64\"\n SizeRootFs:\n description: \"The total size of all the files in this container.\"\n type: \"integer\"\n format: \"int64\"\n Mounts:\n type: \"array\"\n items:\n $ref: \"#/definitions/MountPoint\"\n Config:\n $ref: \"#/definitions/ContainerConfig\"\n NetworkSettings:\n $ref: \"#/definitions/NetworkSettings\"\n examples:\n application/json:\n AppArmorProfile: \"\"\n Args:\n - \"-c\"\n - \"exit 9\"\n Config:\n AttachStderr: true\n AttachStdin: false\n AttachStdout: true\n Cmd:\n - \"/bin/sh\"\n - \"-c\"\n - \"exit 9\"\n Domainname: \"\"\n Env:\n - \"PATH=/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin\"\n Healthcheck:\n Test: [\"CMD-SHELL\", \"exit 0\"]\n Hostname: \"ba033ac44011\"\n Image: \"ubuntu\"\n Labels:\n com.example.vendor: \"Acme\"\n com.example.license: \"GPL\"\n com.example.version: \"1.0\"\n MacAddress: \"\"\n NetworkDisabled: false\n OpenStdin: false\n StdinOnce: false\n Tty: false\n User: \"\"\n Volumes:\n /volumes/data: {}\n WorkingDir: \"\"\n StopSignal: \"SIGTERM\"\n StopTimeout: 10\n Created: \"2015-01-06T15:47:31.485331387Z\"\n Driver: \"devicemapper\"\n ExecIDs:\n - \"b35395de42bc8abd327f9dd65d913b9ba28c74d2f0734eeeae84fa1c616a0fca\"\n - \"3fc1232e5cd20c8de182ed81178503dc6437f4e7ef12b52cc5e8de020652f1c4\"\n HostConfig:\n MaximumIOps: 0\n MaximumIOBps: 0\n BlkioWeight: 0\n BlkioWeightDevice:\n - {}\n BlkioDeviceReadBps:\n - {}\n BlkioDeviceWriteBps:\n - {}\n BlkioDeviceReadIOps:\n - {}\n BlkioDeviceWriteIOps:\n - {}\n ContainerIDFile: \"\"\n CpusetCpus: \"\"\n CpusetMems: \"\"\n CpuPercent: 80\n CpuShares: 0\n CpuPeriod: 100000\n CpuRealtimePeriod: 1000000\n CpuRealtimeRuntime: 10000\n Devices: []\n DeviceRequests:\n - Driver: \"nvidia\"\n Count: -1\n DeviceIDs\": [\"0\", \"1\", \"GPU-fef8089b-4820-abfc-e83e-94318197576e\"]\n Capabilities: [[\"gpu\", \"nvidia\", \"compute\"]]\n Options:\n property1: \"string\"\n property2: \"string\"\n IpcMode: \"\"\n LxcConf: []\n Memory: 0\n MemorySwap: 0\n MemoryReservation: 0\n KernelMemory: 0\n OomKillDisable: false\n OomScoreAdj: 500\n NetworkMode: \"bridge\"\n PidMode: \"\"\n PortBindings: {}\n Privileged: false\n ReadonlyRootfs: false\n PublishAllPorts: false\n RestartPolicy:\n MaximumRetryCount: 2\n Name: \"on-failure\"\n LogConfig:\n Type: \"json-file\"\n Sysctls:\n net.ipv4.ip_forward: \"1\"\n Ulimits:\n - {}\n VolumeDriver: \"\"\n ShmSize: 67108864\n HostnamePath: \"/var/lib/docker/containers/ba033ac4401106a3b513bc9d639eee123ad78ca3616b921167cd74b20e25ed39/hostname\"\n HostsPath: \"/var/lib/docker/containers/ba033ac4401106a3b513bc9d639eee123ad78ca3616b921167cd74b20e25ed39/hosts\"\n LogPath: \"/var/lib/docker/containers/1eb5fabf5a03807136561b3c00adcd2992b535d624d5e18b6cdc6a6844d9767b/1eb5fabf5a03807136561b3c00adcd2992b535d624d5e18b6cdc6a6844d9767b-json.log\"\n Id: \"ba033ac4401106a3b513bc9d639eee123ad78ca3616b921167cd74b20e25ed39\"\n Image: \"04c5d3b7b0656168630d3ba35d8889bd0e9caafcaeb3004d2bfbc47e7c5d35d2\"\n MountLabel: \"\"\n Name: \"/boring_euclid\"\n NetworkSettings:\n Bridge: \"\"\n SandboxID: \"\"\n HairpinMode: false\n LinkLocalIPv6Address: \"\"\n LinkLocalIPv6PrefixLen: 0\n SandboxKey: \"\"\n EndpointID: \"\"\n Gateway: \"\"\n GlobalIPv6Address: \"\"\n GlobalIPv6PrefixLen: 0\n IPAddress: \"\"\n IPPrefixLen: 0\n IPv6Gateway: \"\"\n MacAddress: \"\"\n Networks:\n bridge:\n NetworkID: \"7ea29fc1412292a2d7bba362f9253545fecdfa8ce9a6e37dd10ba8bee7129812\"\n EndpointID: \"7587b82f0dada3656fda26588aee72630c6fab1536d36e394b2bfbcf898c971d\"\n Gateway: \"172.17.0.1\"\n IPAddress: \"172.17.0.2\"\n IPPrefixLen: 16\n IPv6Gateway: \"\"\n GlobalIPv6Address: \"\"\n GlobalIPv6PrefixLen: 0\n MacAddress: \"02:42:ac:12:00:02\"\n Path: \"/bin/sh\"\n ProcessLabel: \"\"\n ResolvConfPath: \"/var/lib/docker/containers/ba033ac4401106a3b513bc9d639eee123ad78ca3616b921167cd74b20e25ed39/resolv.conf\"\n RestartCount: 1\n State:\n Error: \"\"\n ExitCode: 9\n FinishedAt: \"2015-01-06T15:47:32.080254511Z\"\n Health:\n Status: \"healthy\"\n FailingStreak: 0\n Log:\n - Start: \"2019-12-22T10:59:05.6385933Z\"\n End: \"2019-12-22T10:59:05.8078452Z\"\n ExitCode: 0\n Output: \"\"\n OOMKilled: false\n Dead: false\n Paused: false\n Pid: 0\n Restarting: false\n Running: true\n StartedAt: \"2015-01-06T15:47:32.072697474Z\"\n Status: \"running\"\n Mounts:\n - Name: \"fac362...80535\"\n Source: \"/data\"\n Destination: \"/data\"\n Driver: \"local\"\n Mode: \"ro,Z\"\n RW: false\n Propagation: \"\"\n 404:\n description: \"no such container\"\n schema:\n $ref: \"#/definitions/ErrorResponse\"\n examples:\n application/json:\n message: \"No such container: c2ada9df5af8\"\n 500:\n description: \"server error\"\n schema:\n $ref: \"#/definitions/ErrorResponse\"\n parameters:\n - name: \"id\"\n in: \"path\"\n required: true\n description: \"ID or name of the container\"\n type: \"string\"\n - name: \"size\"\n in: \"query\"\n type: \"boolean\"\n default: false\n description: \"Return the size of container as fields `SizeRw` and `SizeRootFs`\"\n tags: [\"Container\"]\n /containers/{id}/top:\n get:\n summary: \"List processes running inside a container\"\n description: |\n On Unix systems, this is done by running the `ps` command. This endpoint\n is not supported on Windows.\n operationId: \"ContainerTop\"\n responses:\n 200:\n description: \"no error\"\n schema:\n type: \"object\"\n title: \"ContainerTopResponse\"\n description: \"OK response to ContainerTop operation\"\n properties:\n Titles:\n description: \"The ps column titles\"\n type: \"array\"\n items:\n type: \"string\"\n Processes:\n description: |\n Each process running in the container, where each is process\n is an array of values corresponding to the titles.\n type: \"array\"\n items:\n type: \"array\"\n items:\n type: \"string\"\n examples:\n application/json:\n Titles:\n - \"UID\"\n - \"PID\"\n - \"PPID\"\n - \"C\"\n - \"STIME\"\n - \"TTY\"\n - \"TIME\"\n - \"CMD\"\n Processes:\n -\n - \"root\"\n - \"13642\"\n - \"882\"\n - \"0\"\n - \"17:03\"\n - \"pts/0\"\n - \"00:00:00\"\n - \"/bin/bash\"\n -\n - \"root\"\n - \"13735\"\n - \"13642\"\n - \"0\"\n - \"17:06\"\n - \"pts/0\"\n - \"00:00:00\"\n - \"sleep 10\"\n 404:\n description: \"no such container\"\n schema:\n $ref: \"#/definitions/ErrorResponse\"\n examples:\n application/json:\n message: \"No such container: c2ada9df5af8\"\n 500:\n description: \"server error\"\n schema:\n $ref: \"#/definitions/ErrorResponse\"\n parameters:\n - name: \"id\"\n in: \"path\"\n required: true\n description: \"ID or name of the container\"\n type: \"string\"\n - name: \"ps_args\"\n in: \"query\"\n description: \"The arguments to pass to `ps`. For example, `aux`\"\n type: \"string\"\n default: \"-ef\"\n tags: [\"Container\"]\n /containers/{id}/logs:\n get:\n summary: \"Get container logs\"\n description: |\n Get `stdout` and `stderr` logs from a container.\n\n Note: This endpoint works only for containers with the `json-file` or\n `journald` logging driver.\n operationId: \"ContainerLogs\"\n responses:\n 200:\n description: |\n logs returned as a stream in response body.\n For the stream format, [see the documentation for the attach endpoint](#operation/ContainerAttach).\n Note that unlike the attach endpoint, the logs endpoint does not\n upgrade the connection and does not set Content-Type.\n schema:\n type: \"string\"\n format: \"binary\"\n 404:\n description: \"no such container\"\n schema:\n $ref: \"#/definitions/ErrorResponse\"\n examples:\n application/json:\n message: \"No such container: c2ada9df5af8\"\n 500:\n description: \"server error\"\n schema:\n $ref: \"#/definitions/ErrorResponse\"\n parameters:\n - name: \"id\"\n in: \"path\"\n required: true\n description: \"ID or name of the container\"\n type: \"string\"\n - name: \"follow\"\n in: \"query\"\n description: \"Keep connection after returning logs.\"\n type: \"boolean\"\n default: false\n - name: \"stdout\"\n in: \"query\"\n description: \"Return logs from `stdout`\"\n type: \"boolean\"\n default: false\n - name: \"stderr\"\n in: \"query\"\n description: \"Return logs from `stderr`\"\n type: \"boolean\"\n default: false\n - name: \"since\"\n in: \"query\"\n description: \"Only return logs since this time, as a UNIX timestamp\"\n type: \"integer\"\n default: 0\n - name: \"until\"\n in: \"query\"\n description: \"Only return logs before this time, as a UNIX timestamp\"\n type: \"integer\"\n default: 0\n - name: \"timestamps\"\n in: \"query\"\n description: \"Add timestamps to every log line\"\n type: \"boolean\"\n default: false\n - name: \"tail\"\n in: \"query\"\n description: |\n Only return this number of log lines from the end of the logs.\n Specify as an integer or `all` to output all log lines.\n type: \"string\"\n default: \"all\"\n tags: [\"Container\"]\n /containers/{id}/changes:\n get:\n summary: \"Get changes on a container’s filesystem\"\n description: |\n Returns which files in a container's filesystem have been added, deleted,\n or modified. The `Kind` of modification can be one of:\n\n - `0`: Modified\n - `1`: Added\n - `2`: Deleted\n operationId: \"ContainerChanges\"\n produces: [\"application/json\"]\n responses:\n 200:\n description: \"The list of changes\"\n schema:\n type: \"array\"\n items:\n type: \"object\"\n x-go-name: \"ContainerChangeResponseItem\"\n title: \"ContainerChangeResponseItem\"\n description: \"change item in response to ContainerChanges operation\"\n required: [Path, Kind]\n properties:\n Path:\n description: \"Path to file that has changed\"\n type: \"string\"\n x-nullable: false\n Kind:\n description: \"Kind of change\"\n type: \"integer\"\n format: \"uint8\"\n enum: [0, 1, 2]\n x-nullable: false\n examples:\n application/json:\n - Path: \"/dev\"\n Kind: 0\n - Path: \"/dev/kmsg\"\n Kind: 1\n - Path: \"/test\"\n Kind: 1\n 404:\n description: \"no such container\"\n schema:\n $ref: \"#/definitions/ErrorResponse\"\n examples:\n application/json:\n message: \"No such container: c2ada9df5af8\"\n 500:\n description: \"server error\"\n schema:\n $ref: \"#/definitions/ErrorResponse\"\n parameters:\n - name: \"id\"\n in: \"path\"\n required: true\n description: \"ID or name of the container\"\n type: \"string\"\n tags: [\"Container\"]\n /containers/{id}/export:\n get:\n summary: \"Export a container\"\n description: \"Export the contents of a container as a tarball.\"\n operationId: \"ContainerExport\"\n produces:\n - \"application/octet-stream\"\n responses:\n 200:\n description: \"no error\"\n 404:\n description: \"no such container\"\n schema:\n $ref: \"#/definitions/ErrorResponse\"\n examples:\n application/json:\n message: \"No such container: c2ada9df5af8\"\n 500:\n description: \"server error\"\n schema:\n $ref: \"#/definitions/ErrorResponse\"\n parameters:\n - name: \"id\"\n in: \"path\"\n required: true\n description: \"ID or name of the container\"\n type: \"string\"\n tags: [\"Container\"]\n /containers/{id}/stats:\n get:\n summary: \"Get container stats based on resource usage\"\n description: |\n This endpoint returns a live stream of a container’s resource usage\n statistics.\n\n The `precpu_stats` is the CPU statistic of the *previous* read, and is\n used to calculate the CPU usage percentage. It is not an exact copy\n of the `cpu_stats` field.\n\n If either `precpu_stats.online_cpus` or `cpu_stats.online_cpus` is\n nil then for compatibility with older daemons the length of the\n corresponding `cpu_usage.percpu_usage` array should be used.\n\n On a cgroup v2 host, the following fields are not set\n * `blkio_stats`: all fields other than `io_service_bytes_recursive`\n * `cpu_stats`: `cpu_usage.percpu_usage`\n * `memory_stats`: `max_usage` and `failcnt`\n Also, `memory_stats.stats` fields are incompatible with cgroup v1.\n\n To calculate the values shown by the `stats` command of the docker cli tool\n the following formulas can be used:\n * used_memory = `memory_stats.usage - memory_stats.stats.cache`\n * available_memory = `memory_stats.limit`\n * Memory usage % = `(used_memory / available_memory) * 100.0`\n * cpu_delta = `cpu_stats.cpu_usage.total_usage - precpu_stats.cpu_usage.total_usage`\n * system_cpu_delta = `cpu_stats.system_cpu_usage - precpu_stats.system_cpu_usage`\n * number_cpus = `lenght(cpu_stats.cpu_usage.percpu_usage)` or `cpu_stats.online_cpus`\n * CPU usage % = `(cpu_delta / system_cpu_delta) * number_cpus * 100.0`\n operationId: \"ContainerStats\"\n produces: [\"application/json\"]\n responses:\n 200:\n description: \"no error\"\n schema:\n type: \"object\"\n examples:\n application/json:\n read: \"2015-01-08T22:57:31.547920715Z\"\n pids_stats:\n current: 3\n networks:\n eth0:\n rx_bytes: 5338\n rx_dropped: 0\n rx_errors: 0\n rx_packets: 36\n tx_bytes: 648\n tx_dropped: 0\n tx_errors: 0\n tx_packets: 8\n eth5:\n rx_bytes: 4641\n rx_dropped: 0\n rx_errors: 0\n rx_packets: 26\n tx_bytes: 690\n tx_dropped: 0\n tx_errors: 0\n tx_packets: 9\n memory_stats:\n stats:\n total_pgmajfault: 0\n cache: 0\n mapped_file: 0\n total_inactive_file: 0\n pgpgout: 414\n rss: 6537216\n total_mapped_file: 0\n writeback: 0\n unevictable: 0\n pgpgin: 477\n total_unevictable: 0\n pgmajfault: 0\n total_rss: 6537216\n total_rss_huge: 6291456\n total_writeback: 0\n total_inactive_anon: 0\n rss_huge: 6291456\n hierarchical_memory_limit: 67108864\n total_pgfault: 964\n total_active_file: 0\n active_anon: 6537216\n total_active_anon: 6537216\n total_pgpgout: 414\n total_cache: 0\n inactive_anon: 0\n active_file: 0\n pgfault: 964\n inactive_file: 0\n total_pgpgin: 477\n max_usage: 6651904\n usage: 6537216\n failcnt: 0\n limit: 67108864\n blkio_stats: {}\n cpu_stats:\n cpu_usage:\n percpu_usage:\n - 8646879\n - 24472255\n - 36438778\n - 30657443\n usage_in_usermode: 50000000\n total_usage: 100215355\n usage_in_kernelmode: 30000000\n system_cpu_usage: 739306590000000\n online_cpus: 4\n throttling_data:\n periods: 0\n throttled_periods: 0\n throttled_time: 0\n precpu_stats:\n cpu_usage:\n percpu_usage:\n - 8646879\n - 24350896\n - 36438778\n - 30657443\n usage_in_usermode: 50000000\n total_usage: 100093996\n usage_in_kernelmode: 30000000\n system_cpu_usage: 9492140000000\n online_cpus: 4\n throttling_data:\n periods: 0\n throttled_periods: 0\n throttled_time: 0\n 404:\n description: \"no such container\"\n schema:\n $ref: \"#/definitions/ErrorResponse\"\n examples:\n application/json:\n message: \"No such container: c2ada9df5af8\"\n 500:\n description: \"server error\"\n schema:\n $ref: \"#/definitions/ErrorResponse\"\n parameters:\n - name: \"id\"\n in: \"path\"\n required: true\n description: \"ID or name of the container\"\n type: \"string\"\n - name: \"stream\"\n in: \"query\"\n description: |\n Stream the output. If false, the stats will be output once and then\n it will disconnect.\n type: \"boolean\"\n default: true\n - name: \"one-shot\"\n in: \"query\"\n description: |\n Only get a single stat instead of waiting for 2 cycles. Must be used\n with `stream=false`.\n type: \"boolean\"\n default: false\n tags: [\"Container\"]\n /containers/{id}/resize:\n post:\n summary: \"Resize a container TTY\"\n description: \"Resize the TTY for a container.\"\n operationId: \"ContainerResize\"\n consumes:\n - \"application/octet-stream\"\n produces:\n - \"text/plain\"\n responses:\n 200:\n description: \"no error\"\n 404:\n description: \"no such container\"\n schema:\n $ref: \"#/definitions/ErrorResponse\"\n examples:\n application/json:\n message: \"No such container: c2ada9df5af8\"\n 500:\n description: \"cannot resize container\"\n schema:\n $ref: \"#/definitions/ErrorResponse\"\n parameters:\n - name: \"id\"\n in: \"path\"\n required: true\n description: \"ID or name of the container\"\n type: \"string\"\n - name: \"h\"\n in: \"query\"\n description: \"Height of the TTY session in characters\"\n type: \"integer\"\n - name: \"w\"\n in: \"query\"\n description: \"Width of the TTY session in characters\"\n type: \"integer\"\n tags: [\"Container\"]\n /containers/{id}/start:\n post:\n summary: \"Start a container\"\n operationId: \"ContainerStart\"\n responses:\n 204:\n description: \"no error\"\n 304:\n description: \"container already started\"\n 404:\n description: \"no such container\"\n schema:\n $ref: \"#/definitions/ErrorResponse\"\n examples:\n application/json:\n message: \"No such container: c2ada9df5af8\"\n 500:\n description: \"server error\"\n schema:\n $ref: \"#/definitions/ErrorResponse\"\n parameters:\n - name: \"id\"\n in: \"path\"\n required: true\n description: \"ID or name of the container\"\n type: \"string\"\n - name: \"detachKeys\"\n in: \"query\"\n description: |\n Override the key sequence for detaching a container. Format is a\n single character `[a-Z]` or `ctrl-` where `` is one\n of: `a-z`, `@`, `^`, `[`, `,` or `_`.\n type: \"string\"\n tags: [\"Container\"]\n /containers/{id}/stop:\n post:\n summary: \"Stop a container\"\n operationId: \"ContainerStop\"\n responses:\n 204:\n description: \"no error\"\n 304:\n description: \"container already stopped\"\n 404:\n description: \"no such container\"\n schema:\n $ref: \"#/definitions/ErrorResponse\"\n examples:\n application/json:\n message: \"No such container: c2ada9df5af8\"\n 500:\n description: \"server error\"\n schema:\n $ref: \"#/definitions/ErrorResponse\"\n parameters:\n - name: \"id\"\n in: \"path\"\n required: true\n description: \"ID or name of the container\"\n type: \"string\"\n - name: \"t\"\n in: \"query\"\n description: \"Number of seconds to wait before killing the container\"\n type: \"integer\"\n tags: [\"Container\"]\n /containers/{id}/restart:\n post:\n summary: \"Restart a container\"\n operationId: \"ContainerRestart\"\n responses:\n 204:\n description: \"no error\"\n 404:\n description: \"no such container\"\n schema:\n $ref: \"#/definitions/ErrorResponse\"\n examples:\n application/json:\n message: \"No such container: c2ada9df5af8\"\n 500:\n description: \"server error\"\n schema:\n $ref: \"#/definitions/ErrorResponse\"\n parameters:\n - name: \"id\"\n in: \"path\"\n required: true\n description: \"ID or name of the container\"\n type: \"string\"\n - name: \"t\"\n in: \"query\"\n description: \"Number of seconds to wait before killing the container\"\n type: \"integer\"\n tags: [\"Container\"]\n /containers/{id}/kill:\n post:\n summary: \"Kill a container\"\n description: |\n Send a POSIX signal to a container, defaulting to killing to the\n container.\n operationId: \"ContainerKill\"\n responses:\n 204:\n description: \"no error\"\n 404:\n description: \"no such container\"\n schema:\n $ref: \"#/definitions/ErrorResponse\"\n examples:\n application/json:\n message: \"No such container: c2ada9df5af8\"\n 409:\n description: \"container is not running\"\n schema:\n $ref: \"#/definitions/ErrorResponse\"\n examples:\n application/json:\n message: \"Container d37cde0fe4ad63c3a7252023b2f9800282894247d145cb5933ddf6e52cc03a28 is not running\"\n 500:\n description: \"server error\"\n schema:\n $ref: \"#/definitions/ErrorResponse\"\n parameters:\n - name: \"id\"\n in: \"path\"\n required: true\n description: \"ID or name of the container\"\n type: \"string\"\n - name: \"signal\"\n in: \"query\"\n description: \"Signal to send to the container as an integer or string (e.g. `SIGINT`)\"\n type: \"string\"\n default: \"SIGKILL\"\n tags: [\"Container\"]\n /containers/{id}/update:\n post:\n summary: \"Update a container\"\n description: |\n Change various configuration options of a container without having to\n recreate it.\n operationId: \"ContainerUpdate\"\n consumes: [\"application/json\"]\n produces: [\"application/json\"]\n responses:\n 200:\n description: \"The container has been updated.\"\n schema:\n type: \"object\"\n title: \"ContainerUpdateResponse\"\n description: \"OK response to ContainerUpdate operation\"\n properties:\n Warnings:\n type: \"array\"\n items:\n type: \"string\"\n 404:\n description: \"no such container\"\n schema:\n $ref: \"#/definitions/ErrorResponse\"\n examples:\n application/json:\n message: \"No such container: c2ada9df5af8\"\n 500:\n description: \"server error\"\n schema:\n $ref: \"#/definitions/ErrorResponse\"\n parameters:\n - name: \"id\"\n in: \"path\"\n required: true\n description: \"ID or name of the container\"\n type: \"string\"\n - name: \"update\"\n in: \"body\"\n required: true\n schema:\n allOf:\n - $ref: \"#/definitions/Resources\"\n - type: \"object\"\n properties:\n RestartPolicy:\n $ref: \"#/definitions/RestartPolicy\"\n example:\n BlkioWeight: 300\n CpuShares: 512\n CpuPeriod: 100000\n CpuQuota: 50000\n CpuRealtimePeriod: 1000000\n CpuRealtimeRuntime: 10000\n CpusetCpus: \"0,1\"\n CpusetMems: \"0\"\n Memory: 314572800\n MemorySwap: 514288000\n MemoryReservation: 209715200\n KernelMemory: 52428800\n RestartPolicy:\n MaximumRetryCount: 4\n Name: \"on-failure\"\n tags: [\"Container\"]\n /containers/{id}/rename:\n post:\n summary: \"Rename a container\"\n operationId: \"ContainerRename\"\n responses:\n 204:\n description: \"no error\"\n 404:\n description: \"no such container\"\n schema:\n $ref: \"#/definitions/ErrorResponse\"\n examples:\n application/json:\n message: \"No such container: c2ada9df5af8\"\n 409:\n description: \"name already in use\"\n schema:\n $ref: \"#/definitions/ErrorResponse\"\n 500:\n description: \"server error\"\n schema:\n $ref: \"#/definitions/ErrorResponse\"\n parameters:\n - name: \"id\"\n in: \"path\"\n required: true\n description: \"ID or name of the container\"\n type: \"string\"\n - name: \"name\"\n in: \"query\"\n required: true\n description: \"New name for the container\"\n type: \"string\"\n tags: [\"Container\"]\n /containers/{id}/pause:\n post:\n summary: \"Pause a container\"\n description: |\n Use the freezer cgroup to suspend all processes in a container.\n\n Traditionally, when suspending a process the `SIGSTOP` signal is used,\n which is observable by the process being suspended. With the freezer\n cgroup the process is unaware, and unable to capture, that it is being\n suspended, and subsequently resumed.\n operationId: \"ContainerPause\"\n responses:\n 204:\n description: \"no error\"\n 404:\n description: \"no such container\"\n schema:\n $ref: \"#/definitions/ErrorResponse\"\n examples:\n application/json:\n message: \"No such container: c2ada9df5af8\"\n 500:\n description: \"server error\"\n schema:\n $ref: \"#/definitions/ErrorResponse\"\n parameters:\n - name: \"id\"\n in: \"path\"\n required: true\n description: \"ID or name of the container\"\n type: \"string\"\n tags: [\"Container\"]\n /containers/{id}/unpause:\n post:\n summary: \"Unpause a container\"\n description: \"Resume a container which has been paused.\"\n operationId: \"ContainerUnpause\"\n responses:\n 204:\n description: \"no error\"\n 404:\n description: \"no such container\"\n schema:\n $ref: \"#/definitions/ErrorResponse\"\n examples:\n application/json:\n message: \"No such container: c2ada9df5af8\"\n 500:\n description: \"server error\"\n schema:\n $ref: \"#/definitions/ErrorResponse\"\n parameters:\n - name: \"id\"\n in: \"path\"\n required: true\n description: \"ID or name of the container\"\n type: \"string\"\n tags: [\"Container\"]\n /containers/{id}/attach:\n post:\n summary: \"Attach to a container\"\n description: |\n Attach to a container to read its output or send it input. You can attach\n to the same container multiple times and you can reattach to containers\n that have been detached.\n\n Either the `stream` or `logs` parameter must be `true` for this endpoint\n to do anything.\n\n See the [documentation for the `docker attach` command](https://docs.docker.com/engine/reference/commandline/attach/)\n for more details.\n\n ### Hijacking\n\n This endpoint hijacks the HTTP connection to transport `stdin`, `stdout`,\n and `stderr` on the same socket.\n\n This is the response from the daemon for an attach request:\n\n ```\n HTTP/1.1 200 OK\n Content-Type: application/vnd.docker.raw-stream\n\n [STREAM]\n ```\n\n After the headers and two new lines, the TCP connection can now be used\n for raw, bidirectional communication between the client and server.\n\n To hint potential proxies about connection hijacking, the Docker client\n can also optionally send connection upgrade headers.\n\n For example, the client sends this request to upgrade the connection:\n\n ```\n POST /containers/16253994b7c4/attach?stream=1&stdout=1 HTTP/1.1\n Upgrade: tcp\n Connection: Upgrade\n ```\n\n The Docker daemon will respond with a `101 UPGRADED` response, and will\n similarly follow with the raw stream:\n\n ```\n HTTP/1.1 101 UPGRADED\n Content-Type: application/vnd.docker.raw-stream\n Connection: Upgrade\n Upgrade: tcp\n\n [STREAM]\n ```\n\n ### Stream format\n\n When the TTY setting is disabled in [`POST /containers/create`](#operation/ContainerCreate),\n the stream over the hijacked connected is multiplexed to separate out\n `stdout` and `stderr`. The stream consists of a series of frames, each\n containing a header and a payload.\n\n The header contains the information which the stream writes (`stdout` or\n `stderr`). It also contains the size of the associated frame encoded in\n the last four bytes (`uint32`).\n\n It is encoded on the first eight bytes like this:\n\n ```go\n header := [8]byte{STREAM_TYPE, 0, 0, 0, SIZE1, SIZE2, SIZE3, SIZE4}\n ```\n\n `STREAM_TYPE` can be:\n\n - 0: `stdin` (is written on `stdout`)\n - 1: `stdout`\n - 2: `stderr`\n\n `SIZE1, SIZE2, SIZE3, SIZE4` are the four bytes of the `uint32` size\n encoded as big endian.\n\n Following the header is the payload, which is the specified number of\n bytes of `STREAM_TYPE`.\n\n The simplest way to implement this protocol is the following:\n\n 1. Read 8 bytes.\n 2. Choose `stdout` or `stderr` depending on the first byte.\n 3. Extract the frame size from the last four bytes.\n 4. Read the extracted size and output it on the correct output.\n 5. Goto 1.\n\n ### Stream format when using a TTY\n\n When the TTY setting is enabled in [`POST /containers/create`](#operation/ContainerCreate),\n the stream is not multiplexed. The data exchanged over the hijacked\n connection is simply the raw data from the process PTY and client's\n `stdin`.\n\n operationId: \"ContainerAttach\"\n produces:\n - \"application/vnd.docker.raw-stream\"\n responses:\n 101:\n description: \"no error, hints proxy about hijacking\"\n 200:\n description: \"no error, no upgrade header found\"\n 400:\n description: \"bad parameter\"\n schema:\n $ref: \"#/definitions/ErrorResponse\"\n 404:\n description: \"no such container\"\n schema:\n $ref: \"#/definitions/ErrorResponse\"\n examples:\n application/json:\n message: \"No such container: c2ada9df5af8\"\n 500:\n description: \"server error\"\n schema:\n $ref: \"#/definitions/ErrorResponse\"\n parameters:\n - name: \"id\"\n in: \"path\"\n required: true\n description: \"ID or name of the container\"\n type: \"string\"\n - name: \"detachKeys\"\n in: \"query\"\n description: |\n Override the key sequence for detaching a container.Format is a single\n character `[a-Z]` or `ctrl-` where `` is one of: `a-z`,\n `@`, `^`, `[`, `,` or `_`.\n type: \"string\"\n - name: \"logs\"\n in: \"query\"\n description: |\n Replay previous logs from the container.\n\n This is useful for attaching to a container that has started and you\n want to output everything since the container started.\n\n If `stream` is also enabled, once all the previous output has been\n returned, it will seamlessly transition into streaming current\n output.\n type: \"boolean\"\n default: false\n - name: \"stream\"\n in: \"query\"\n description: |\n Stream attached streams from the time the request was made onwards.\n type: \"boolean\"\n default: false\n - name: \"stdin\"\n in: \"query\"\n description: \"Attach to `stdin`\"\n type: \"boolean\"\n default: false\n - name: \"stdout\"\n in: \"query\"\n description: \"Attach to `stdout`\"\n type: \"boolean\"\n default: false\n - name: \"stderr\"\n in: \"query\"\n description: \"Attach to `stderr`\"\n type: \"boolean\"\n default: false\n tags: [\"Container\"]\n /containers/{id}/attach/ws:\n get:\n summary: \"Attach to a container via a websocket\"\n operationId: \"ContainerAttachWebsocket\"\n responses:\n 101:\n description: \"no error, hints proxy about hijacking\"\n 200:\n description: \"no error, no upgrade header found\"\n 400:\n description: \"bad parameter\"\n schema:\n $ref: \"#/definitions/ErrorResponse\"\n 404:\n description: \"no such container\"\n schema:\n $ref: \"#/definitions/ErrorResponse\"\n examples:\n application/json:\n message: \"No such container: c2ada9df5af8\"\n 500:\n description: \"server error\"\n schema:\n $ref: \"#/definitions/ErrorResponse\"\n parameters:\n - name: \"id\"\n in: \"path\"\n required: true\n description: \"ID or name of the container\"\n type: \"string\"\n - name: \"detachKeys\"\n in: \"query\"\n description: |\n Override the key sequence for detaching a container.Format is a single\n character `[a-Z]` or `ctrl-` where `` is one of: `a-z`,\n `@`, `^`, `[`, `,`, or `_`.\n type: \"string\"\n - name: \"logs\"\n in: \"query\"\n description: \"Return logs\"\n type: \"boolean\"\n default: false\n - name: \"stream\"\n in: \"query\"\n description: \"Return stream\"\n type: \"boolean\"\n default: false\n - name: \"stdin\"\n in: \"query\"\n description: \"Attach to `stdin`\"\n type: \"boolean\"\n default: false\n - name: \"stdout\"\n in: \"query\"\n description: \"Attach to `stdout`\"\n type: \"boolean\"\n default: false\n - name: \"stderr\"\n in: \"query\"\n description: \"Attach to `stderr`\"\n type: \"boolean\"\n default: false\n tags: [\"Container\"]\n /containers/{id}/wait:\n post:\n summary: \"Wait for a container\"\n description: \"Block until a container stops, then returns the exit code.\"\n operationId: \"ContainerWait\"\n produces: [\"application/json\"]\n responses:\n 200:\n description: \"The container has exit.\"\n schema:\n type: \"object\"\n title: \"ContainerWaitResponse\"\n description: \"OK response to ContainerWait operation\"\n required: [StatusCode]\n properties:\n StatusCode:\n description: \"Exit code of the container\"\n type: \"integer\"\n x-nullable: false\n Error:\n description: \"container waiting error, if any\"\n type: \"object\"\n properties:\n Message:\n description: \"Details of an error\"\n type: \"string\"\n 404:\n description: \"no such container\"\n schema:\n $ref: \"#/definitions/ErrorResponse\"\n examples:\n application/json:\n message: \"No such container: c2ada9df5af8\"\n 500:\n description: \"server error\"\n schema:\n $ref: \"#/definitions/ErrorResponse\"\n parameters:\n - name: \"id\"\n in: \"path\"\n required: true\n description: \"ID or name of the container\"\n type: \"string\"\n - name: \"condition\"\n in: \"query\"\n description: |\n Wait until a container state reaches the given condition, either\n 'not-running' (default), 'next-exit', or 'removed'.\n type: \"string\"\n default: \"not-running\"\n tags: [\"Container\"]\n /containers/{id}:\n delete:\n summary: \"Remove a container\"\n operationId: \"ContainerDelete\"\n responses:\n 204:\n description: \"no error\"\n 400:\n description: \"bad parameter\"\n schema:\n $ref: \"#/definitions/ErrorResponse\"\n 404:\n description: \"no such container\"\n schema:\n $ref: \"#/definitions/ErrorResponse\"\n examples:\n application/json:\n message: \"No such container: c2ada9df5af8\"\n 409:\n description: \"conflict\"\n schema:\n $ref: \"#/definitions/ErrorResponse\"\n examples:\n application/json:\n message: |\n You cannot remove a running container: c2ada9df5af8. Stop the\n container before attempting removal or force remove\n 500:\n description: \"server error\"\n schema:\n $ref: \"#/definitions/ErrorResponse\"\n parameters:\n - name: \"id\"\n in: \"path\"\n required: true\n description: \"ID or name of the container\"\n type: \"string\"\n - name: \"v\"\n in: \"query\"\n description: \"Remove anonymous volumes associated with the container.\"\n type: \"boolean\"\n default: false\n - name: \"force\"\n in: \"query\"\n description: \"If the container is running, kill it before removing it.\"\n type: \"boolean\"\n default: false\n - name: \"link\"\n in: \"query\"\n description: \"Remove the specified link associated with the container.\"\n type: \"boolean\"\n default: false\n tags: [\"Container\"]\n /containers/{id}/archive:\n head:\n summary: \"Get information about files in a container\"\n description: |\n A response header `X-Docker-Container-Path-Stat` is returned, containing\n a base64 - encoded JSON object with some filesystem header information\n about the path.\n operationId: \"ContainerArchiveInfo\"\n responses:\n 200:\n description: \"no error\"\n headers:\n X-Docker-Container-Path-Stat:\n type: \"string\"\n description: |\n A base64 - encoded JSON object with some filesystem header\n information about the path\n 400:\n description: \"Bad parameter\"\n schema:\n allOf:\n - $ref: \"#/definitions/ErrorResponse\"\n - type: \"object\"\n properties:\n message:\n description: |\n The error message. Either \"must specify path parameter\"\n (path cannot be empty) or \"not a directory\" (path was\n asserted to be a directory but exists as a file).\n type: \"string\"\n x-nullable: false\n 404:\n description: \"Container or path does not exist\"\n schema:\n $ref: \"#/definitions/ErrorResponse\"\n examples:\n application/json:\n message: \"No such container: c2ada9df5af8\"\n 500:\n description: \"Server error\"\n schema:\n $ref: \"#/definitions/ErrorResponse\"\n parameters:\n - name: \"id\"\n in: \"path\"\n required: true\n description: \"ID or name of the container\"\n type: \"string\"\n - name: \"path\"\n in: \"query\"\n required: true\n description: \"Resource in the container’s filesystem to archive.\"\n type: \"string\"\n tags: [\"Container\"]\n get:\n summary: \"Get an archive of a filesystem resource in a container\"\n description: \"Get a tar archive of a resource in the filesystem of container id.\"\n operationId: \"ContainerArchive\"\n produces: [\"application/x-tar\"]\n responses:\n 200:\n description: \"no error\"\n 400:\n description: \"Bad parameter\"\n schema:\n allOf:\n - $ref: \"#/definitions/ErrorResponse\"\n - type: \"object\"\n properties:\n message:\n description: |\n The error message. Either \"must specify path parameter\"\n (path cannot be empty) or \"not a directory\" (path was\n asserted to be a directory but exists as a file).\n type: \"string\"\n x-nullable: false\n 404:\n description: \"Container or path does not exist\"\n schema:\n $ref: \"#/definitions/ErrorResponse\"\n examples:\n application/json:\n message: \"No such container: c2ada9df5af8\"\n 500:\n description: \"server error\"\n schema:\n $ref: \"#/definitions/ErrorResponse\"\n parameters:\n - name: \"id\"\n in: \"path\"\n required: true\n description: \"ID or name of the container\"\n type: \"string\"\n - name: \"path\"\n in: \"query\"\n required: true\n description: \"Resource in the container’s filesystem to archive.\"\n type: \"string\"\n tags: [\"Container\"]\n put:\n summary: \"Extract an archive of files or folders to a directory in a container\"\n description: \"Upload a tar archive to be extracted to a path in the filesystem of container id.\"\n operationId: \"PutContainerArchive\"\n consumes: [\"application/x-tar\", \"application/octet-stream\"]\n responses:\n 200:\n description: \"The content was extracted successfully\"\n 400:\n description: \"Bad parameter\"\n schema:\n $ref: \"#/definitions/ErrorResponse\"\n 403:\n description: \"Permission denied, the volume or container rootfs is marked as read-only.\"\n schema:\n $ref: \"#/definitions/ErrorResponse\"\n 404:\n description: \"No such container or path does not exist inside the container\"\n schema:\n $ref: \"#/definitions/ErrorResponse\"\n examples:\n application/json:\n message: \"No such container: c2ada9df5af8\"\n 500:\n description: \"Server error\"\n schema:\n $ref: \"#/definitions/ErrorResponse\"\n parameters:\n - name: \"id\"\n in: \"path\"\n required: true\n description: \"ID or name of the container\"\n type: \"string\"\n - name: \"path\"\n in: \"query\"\n required: true\n description: \"Path to a directory in the container to extract the archive’s contents into. \"\n type: \"string\"\n - name: \"noOverwriteDirNonDir\"\n in: \"query\"\n description: |\n If `1`, `true`, or `True` then it will be an error if unpacking the\n given content would cause an existing directory to be replaced with\n a non-directory and vice versa.\n type: \"string\"\n - name: \"copyUIDGID\"\n in: \"query\"\n description: |\n If `1`, `true`, then it will copy UID/GID maps to the dest file or\n dir\n type: \"string\"\n - name: \"inputStream\"\n in: \"body\"\n required: true\n description: |\n The input stream must be a tar archive compressed with one of the\n following algorithms: `identity` (no compression), `gzip`, `bzip2`,\n or `xz`.\n schema:\n type: \"string\"\n format: \"binary\"\n tags: [\"Container\"]\n /containers/prune:\n post:\n summary: \"Delete stopped containers\"\n produces:\n - \"application/json\"\n operationId: \"ContainerPrune\"\n parameters:\n - name: \"filters\"\n in: \"query\"\n description: |\n Filters to process on the prune list, encoded as JSON (a `map[string][]string`).\n\n Available filters:\n - `until=` Prune containers created before this timestamp. The `` can be Unix timestamps, date formatted timestamps, or Go duration strings (e.g. `10m`, `1h30m`) computed relative to the daemon machine’s time.\n - `label` (`label=`, `label==`, `label!=`, or `label!==`) Prune containers with (or without, in case `label!=...` is used) the specified labels.\n type: \"string\"\n responses:\n 200:\n description: \"No error\"\n schema:\n type: \"object\"\n title: \"ContainerPruneResponse\"\n properties:\n ContainersDeleted:\n description: \"Container IDs that were deleted\"\n type: \"array\"\n items:\n type: \"string\"\n SpaceReclaimed:\n description: \"Disk space reclaimed in bytes\"\n type: \"integer\"\n format: \"int64\"\n 500:\n description: \"Server error\"\n schema:\n $ref: \"#/definitions/ErrorResponse\"\n tags: [\"Container\"]\n /images/json:\n get:\n summary: \"List Images\"\n description: \"Returns a list of images on the server. Note that it uses a different, smaller representation of an image than inspecting a single image.\"\n operationId: \"ImageList\"\n produces:\n - \"application/json\"\n responses:\n 200:\n description: \"Summary image data for the images matching the query\"\n schema:\n type: \"array\"\n items:\n $ref: \"#/definitions/ImageSummary\"\n examples:\n application/json:\n - Id: \"sha256:e216a057b1cb1efc11f8a268f37ef62083e70b1b38323ba252e25ac88904a7e8\"\n ParentId: \"\"\n RepoTags:\n - \"ubuntu:12.04\"\n - \"ubuntu:precise\"\n RepoDigests:\n - \"ubuntu@sha256:992069aee4016783df6345315302fa59681aae51a8eeb2f889dea59290f21787\"\n Created: 1474925151\n Size: 103579269\n VirtualSize: 103579269\n SharedSize: 0\n Labels: {}\n Containers: 2\n - Id: \"sha256:3e314f95dcace0f5e4fd37b10862fe8398e3c60ed36600bc0ca5fda78b087175\"\n ParentId: \"\"\n RepoTags:\n - \"ubuntu:12.10\"\n - \"ubuntu:quantal\"\n RepoDigests:\n - \"ubuntu@sha256:002fba3e3255af10be97ea26e476692a7ebed0bb074a9ab960b2e7a1526b15d7\"\n - \"ubuntu@sha256:68ea0200f0b90df725d99d823905b04cf844f6039ef60c60bf3e019915017bd3\"\n Created: 1403128455\n Size: 172064416\n VirtualSize: 172064416\n SharedSize: 0\n Labels: {}\n Containers: 5\n 500:\n description: \"server error\"\n schema:\n $ref: \"#/definitions/ErrorResponse\"\n parameters:\n - name: \"all\"\n in: \"query\"\n description: \"Show all images. Only images from a final layer (no children) are shown by default.\"\n type: \"boolean\"\n default: false\n - name: \"filters\"\n in: \"query\"\n description: |\n A JSON encoded value of the filters (a `map[string][]string`) to\n process on the images list.\n\n Available filters:\n\n - `before`=(`[:]`, `` or ``)\n - `dangling=true`\n - `label=key` or `label=\"key=value\"` of an image label\n - `reference`=(`[:]`)\n - `since`=(`[:]`, `` or ``)\n type: \"string\"\n - name: \"shared-size\"\n in: \"query\"\n description: \"Compute and show shared size as a `SharedSize` field on each image.\"\n type: \"boolean\"\n default: false\n - name: \"digests\"\n in: \"query\"\n description: \"Show digest information as a `RepoDigests` field on each image.\"\n type: \"boolean\"\n default: false\n tags: [\"Image\"]\n /build:\n post:\n summary: \"Build an image\"\n description: |\n Build an image from a tar archive with a `Dockerfile` in it.\n\n The `Dockerfile` specifies how the image is built from the tar archive. It is typically in the archive's root, but can be at a different path or have a different name by specifying the `dockerfile` parameter. [See the `Dockerfile` reference for more information](https://docs.docker.com/engine/reference/builder/).\n\n The Docker daemon performs a preliminary validation of the `Dockerfile` before starting the build, and returns an error if the syntax is incorrect. After that, each instruction is run one-by-one until the ID of the new image is output.\n\n The build is canceled if the client drops the connection by quitting or being killed.\n operationId: \"ImageBuild\"\n consumes:\n - \"application/octet-stream\"\n produces:\n - \"application/json\"\n parameters:\n - name: \"inputStream\"\n in: \"body\"\n description: \"A tar archive compressed with one of the following algorithms: identity (no compression), gzip, bzip2, xz.\"\n schema:\n type: \"string\"\n format: \"binary\"\n - name: \"dockerfile\"\n in: \"query\"\n description: \"Path within the build context to the `Dockerfile`. This is ignored if `remote` is specified and points to an external `Dockerfile`.\"\n type: \"string\"\n default: \"Dockerfile\"\n - name: \"t\"\n in: \"query\"\n description: \"A name and optional tag to apply to the image in the `name:tag` format. If you omit the tag the default `latest` value is assumed. You can provide several `t` parameters.\"\n type: \"string\"\n - name: \"extrahosts\"\n in: \"query\"\n description: \"Extra hosts to add to /etc/hosts\"\n type: \"string\"\n - name: \"remote\"\n in: \"query\"\n description: \"A Git repository URI or HTTP/HTTPS context URI. If the URI points to a single text file, the file’s contents are placed into a file called `Dockerfile` and the image is built from that file. If the URI points to a tarball, the file is downloaded by the daemon and the contents therein used as the context for the build. If the URI points to a tarball and the `dockerfile` parameter is also specified, there must be a file with the corresponding path inside the tarball.\"\n type: \"string\"\n - name: \"q\"\n in: \"query\"\n description: \"Suppress verbose build output.\"\n type: \"boolean\"\n default: false\n - name: \"nocache\"\n in: \"query\"\n description: \"Do not use the cache when building the image.\"\n type: \"boolean\"\n default: false\n - name: \"cachefrom\"\n in: \"query\"\n description: \"JSON array of images used for build cache resolution.\"\n type: \"string\"\n - name: \"pull\"\n in: \"query\"\n description: \"Attempt to pull the image even if an older image exists locally.\"\n type: \"string\"\n - name: \"rm\"\n in: \"query\"\n description: \"Remove intermediate containers after a successful build.\"\n type: \"boolean\"\n default: true\n - name: \"forcerm\"\n in: \"query\"\n description: \"Always remove intermediate containers, even upon failure.\"\n type: \"boolean\"\n default: false\n - name: \"memory\"\n in: \"query\"\n description: \"Set memory limit for build.\"\n type: \"integer\"\n - name: \"memswap\"\n in: \"query\"\n description: \"Total memory (memory + swap). Set as `-1` to disable swap.\"\n type: \"integer\"\n - name: \"cpushares\"\n in: \"query\"\n description: \"CPU shares (relative weight).\"\n type: \"integer\"\n - name: \"cpusetcpus\"\n in: \"query\"\n description: \"CPUs in which to allow execution (e.g., `0-3`, `0,1`).\"\n type: \"string\"\n - name: \"cpuperiod\"\n in: \"query\"\n description: \"The length of a CPU period in microseconds.\"\n type: \"integer\"\n - name: \"cpuquota\"\n in: \"query\"\n description: \"Microseconds of CPU time that the container can get in a CPU period.\"\n type: \"integer\"\n - name: \"buildargs\"\n in: \"query\"\n description: >\n JSON map of string pairs for build-time variables. Users pass these values at build-time. Docker\n uses the buildargs as the environment context for commands run via the `Dockerfile` RUN\n instruction, or for variable expansion in other `Dockerfile` instructions. This is not meant for\n passing secret values.\n\n\n For example, the build arg `FOO=bar` would become `{\"FOO\":\"bar\"}` in JSON. This would result in the\n query parameter `buildargs={\"FOO\":\"bar\"}`. Note that `{\"FOO\":\"bar\"}` should be URI component encoded.\n\n\n [Read more about the buildargs instruction.](https://docs.docker.com/engine/reference/builder/#arg)\n type: \"string\"\n - name: \"shmsize\"\n in: \"query\"\n description: \"Size of `/dev/shm` in bytes. The size must be greater than 0. If omitted the system uses 64MB.\"\n type: \"integer\"\n - name: \"squash\"\n in: \"query\"\n description: \"Squash the resulting images layers into a single layer. *(Experimental release only.)*\"\n type: \"boolean\"\n - name: \"labels\"\n in: \"query\"\n description: \"Arbitrary key/value labels to set on the image, as a JSON map of string pairs.\"\n type: \"string\"\n - name: \"networkmode\"\n in: \"query\"\n description: |\n Sets the networking mode for the run commands during build. Supported\n standard values are: `bridge`, `host`, `none`, and `container:`.\n Any other value is taken as a custom network's name or ID to which this\n container should connect to.\n type: \"string\"\n - name: \"Content-type\"\n in: \"header\"\n type: \"string\"\n enum:\n - \"application/x-tar\"\n default: \"application/x-tar\"\n - name: \"X-Registry-Config\"\n in: \"header\"\n description: |\n This is a base64-encoded JSON object with auth configurations for multiple registries that a build may refer to.\n\n The key is a registry URL, and the value is an auth configuration object, [as described in the authentication section](#section/Authentication). For example:\n\n ```\n {\n \"docker.example.com\": {\n \"username\": \"janedoe\",\n \"password\": \"hunter2\"\n },\n \"https://index.docker.io/v1/\": {\n \"username\": \"mobydock\",\n \"password\": \"conta1n3rize14\"\n }\n }\n ```\n\n Only the registry domain name (and port if not the default 443) are required. However, for legacy reasons, the Docker Hub registry must be specified with both a `https://` prefix and a `/v1/` suffix even though Docker will prefer to use the v2 registry API.\n type: \"string\"\n - name: \"platform\"\n in: \"query\"\n description: \"Platform in the format os[/arch[/variant]]\"\n type: \"string\"\n default: \"\"\n - name: \"target\"\n in: \"query\"\n description: \"Target build stage\"\n type: \"string\"\n default: \"\"\n - name: \"outputs\"\n in: \"query\"\n description: \"BuildKit output configuration\"\n type: \"string\"\n default: \"\"\n responses:\n 200:\n description: \"no error\"\n 400:\n description: \"Bad parameter\"\n schema:\n $ref: \"#/definitions/ErrorResponse\"\n 500:\n description: \"server error\"\n schema:\n $ref: \"#/definitions/ErrorResponse\"\n tags: [\"Image\"]\n /build/prune:\n post:\n summary: \"Delete builder cache\"\n produces:\n - \"application/json\"\n operationId: \"BuildPrune\"\n parameters:\n - name: \"keep-storage\"\n in: \"query\"\n description: \"Amount of disk space in bytes to keep for cache\"\n type: \"integer\"\n format: \"int64\"\n - name: \"all\"\n in: \"query\"\n type: \"boolean\"\n description: \"Remove all types of build cache\"\n - name: \"filters\"\n in: \"query\"\n type: \"string\"\n description: |\n A JSON encoded value of the filters (a `map[string][]string`) to\n process on the list of build cache objects.\n\n Available filters:\n\n - `until=`: duration relative to daemon's time, during which build cache was not used, in Go's duration format (e.g., '24h')\n - `id=`\n - `parent=`\n - `type=`\n - `description=`\n - `inuse`\n - `shared`\n - `private`\n responses:\n 200:\n description: \"No error\"\n schema:\n type: \"object\"\n title: \"BuildPruneResponse\"\n properties:\n CachesDeleted:\n type: \"array\"\n items:\n description: \"ID of build cache object\"\n type: \"string\"\n SpaceReclaimed:\n description: \"Disk space reclaimed in bytes\"\n type: \"integer\"\n format: \"int64\"\n 500:\n description: \"Server error\"\n schema:\n $ref: \"#/definitions/ErrorResponse\"\n tags: [\"Image\"]\n /images/create:\n post:\n summary: \"Create an image\"\n description: \"Create an image by either pulling it from a registry or importing it.\"\n operationId: \"ImageCreate\"\n consumes:\n - \"text/plain\"\n - \"application/octet-stream\"\n produces:\n - \"application/json\"\n responses:\n 200:\n description: \"no error\"\n 404:\n description: \"repository does not exist or no read access\"\n schema:\n $ref: \"#/definitions/ErrorResponse\"\n 500:\n description: \"server error\"\n schema:\n $ref: \"#/definitions/ErrorResponse\"\n parameters:\n - name: \"fromImage\"\n in: \"query\"\n description: \"Name of the image to pull. The name may include a tag or digest. This parameter may only be used when pulling an image. The pull is cancelled if the HTTP connection is closed.\"\n type: \"string\"\n - name: \"fromSrc\"\n in: \"query\"\n description: \"Source to import. The value may be a URL from which the image can be retrieved or `-` to read the image from the request body. This parameter may only be used when importing an image.\"\n type: \"string\"\n - name: \"repo\"\n in: \"query\"\n description: \"Repository name given to an image when it is imported. The repo may include a tag. This parameter may only be used when importing an image.\"\n type: \"string\"\n - name: \"tag\"\n in: \"query\"\n description: \"Tag or digest. If empty when pulling an image, this causes all tags for the given image to be pulled.\"\n type: \"string\"\n - name: \"message\"\n in: \"query\"\n description: \"Set commit message for imported image.\"\n type: \"string\"\n - name: \"inputImage\"\n in: \"body\"\n description: \"Image content if the value `-` has been specified in fromSrc query parameter\"\n schema:\n type: \"string\"\n required: false\n - name: \"X-Registry-Auth\"\n in: \"header\"\n description: |\n A base64url-encoded auth configuration.\n\n Refer to the [authentication section](#section/Authentication) for\n details.\n type: \"string\"\n - name: \"changes\"\n in: \"query\"\n description: |\n Apply `Dockerfile` instructions to the image that is created,\n for example: `changes=ENV DEBUG=true`.\n Note that `ENV DEBUG=true` should be URI component encoded.\n\n Supported `Dockerfile` instructions:\n `CMD`|`ENTRYPOINT`|`ENV`|`EXPOSE`|`ONBUILD`|`USER`|`VOLUME`|`WORKDIR`\n type: \"array\"\n items:\n type: \"string\"\n - name: \"platform\"\n in: \"query\"\n description: \"Platform in the format os[/arch[/variant]]\"\n type: \"string\"\n default: \"\"\n tags: [\"Image\"]\n /images/{name}/json:\n get:\n summary: \"Inspect an image\"\n description: \"Return low-level information about an image.\"\n operationId: \"ImageInspect\"\n produces:\n - \"application/json\"\n responses:\n 200:\n description: \"No error\"\n schema:\n $ref: \"#/definitions/Image\"\n examples:\n application/json:\n Id: \"sha256:85f05633ddc1c50679be2b16a0479ab6f7637f8884e0cfe0f4d20e1ebb3d6e7c\"\n Container: \"cb91e48a60d01f1e27028b4fc6819f4f290b3cf12496c8176ec714d0d390984a\"\n Comment: \"\"\n Os: \"linux\"\n Architecture: \"amd64\"\n Parent: \"sha256:91e54dfb11794fad694460162bf0cb0a4fa710cfa3f60979c177d920813e267c\"\n ContainerConfig:\n Tty: false\n Hostname: \"e611e15f9c9d\"\n Domainname: \"\"\n AttachStdout: false\n PublishService: \"\"\n AttachStdin: false\n OpenStdin: false\n StdinOnce: false\n NetworkDisabled: false\n OnBuild: []\n Image: \"91e54dfb11794fad694460162bf0cb0a4fa710cfa3f60979c177d920813e267c\"\n User: \"\"\n WorkingDir: \"\"\n MacAddress: \"\"\n AttachStderr: false\n Labels:\n com.example.license: \"GPL\"\n com.example.version: \"1.0\"\n com.example.vendor: \"Acme\"\n Env:\n - \"PATH=/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin\"\n Cmd:\n - \"/bin/sh\"\n - \"-c\"\n - \"#(nop) LABEL com.example.vendor=Acme com.example.license=GPL com.example.version=1.0\"\n DockerVersion: \"1.9.0-dev\"\n VirtualSize: 188359297\n Size: 0\n Author: \"\"\n Created: \"2015-09-10T08:30:53.26995814Z\"\n GraphDriver:\n Name: \"aufs\"\n Data: {}\n RepoDigests:\n - \"localhost:5000/test/busybox/example@sha256:cbbf2f9a99b47fc460d422812b6a5adff7dfee951d8fa2e4a98caa0382cfbdbf\"\n RepoTags:\n - \"example:1.0\"\n - \"example:latest\"\n - \"example:stable\"\n Config:\n Image: \"91e54dfb11794fad694460162bf0cb0a4fa710cfa3f60979c177d920813e267c\"\n NetworkDisabled: false\n OnBuild: []\n StdinOnce: false\n PublishService: \"\"\n AttachStdin: false\n OpenStdin: false\n Domainname: \"\"\n AttachStdout: false\n Tty: false\n Hostname: \"e611e15f9c9d\"\n Cmd:\n - \"/bin/bash\"\n Env:\n - \"PATH=/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin\"\n Labels:\n com.example.vendor: \"Acme\"\n com.example.version: \"1.0\"\n com.example.license: \"GPL\"\n MacAddress: \"\"\n AttachStderr: false\n WorkingDir: \"\"\n User: \"\"\n RootFS:\n Type: \"layers\"\n Layers:\n - \"sha256:1834950e52ce4d5a88a1bbd131c537f4d0e56d10ff0dd69e66be3b7dfa9df7e6\"\n - \"sha256:5f70bf18a086007016e948b04aed3b82103a36bea41755b6cddfaf10ace3c6ef\"\n 404:\n description: \"No such image\"\n schema:\n $ref: \"#/definitions/ErrorResponse\"\n examples:\n application/json:\n message: \"No such image: someimage (tag: latest)\"\n 500:\n description: \"Server error\"\n schema:\n $ref: \"#/definitions/ErrorResponse\"\n parameters:\n - name: \"name\"\n in: \"path\"\n description: \"Image name or id\"\n type: \"string\"\n required: true\n tags: [\"Image\"]\n /images/{name}/history:\n get:\n summary: \"Get the history of an image\"\n description: \"Return parent layers of an image.\"\n operationId: \"ImageHistory\"\n produces: [\"application/json\"]\n responses:\n 200:\n description: \"List of image layers\"\n schema:\n type: \"array\"\n items:\n type: \"object\"\n x-go-name: HistoryResponseItem\n title: \"HistoryResponseItem\"\n description: \"individual image layer information in response to ImageHistory operation\"\n required: [Id, Created, CreatedBy, Tags, Size, Comment]\n properties:\n Id:\n type: \"string\"\n x-nullable: false\n Created:\n type: \"integer\"\n format: \"int64\"\n x-nullable: false\n CreatedBy:\n type: \"string\"\n x-nullable: false\n Tags:\n type: \"array\"\n items:\n type: \"string\"\n Size:\n type: \"integer\"\n format: \"int64\"\n x-nullable: false\n Comment:\n type: \"string\"\n x-nullable: false\n examples:\n application/json:\n - Id: \"3db9c44f45209632d6050b35958829c3a2aa256d81b9a7be45b362ff85c54710\"\n Created: 1398108230\n CreatedBy: \"/bin/sh -c #(nop) ADD file:eb15dbd63394e063b805a3c32ca7bf0266ef64676d5a6fab4801f2e81e2a5148 in /\"\n Tags:\n - \"ubuntu:lucid\"\n - \"ubuntu:10.04\"\n Size: 182964289\n Comment: \"\"\n - Id: \"6cfa4d1f33fb861d4d114f43b25abd0ac737509268065cdfd69d544a59c85ab8\"\n Created: 1398108222\n CreatedBy: \"/bin/sh -c #(nop) MAINTAINER Tianon Gravi - mkimage-debootstrap.sh -i iproute,iputils-ping,ubuntu-minimal -t lucid.tar.xz lucid http://archive.ubuntu.com/ubuntu/\"\n Tags: []\n Size: 0\n Comment: \"\"\n - Id: \"511136ea3c5a64f264b78b5433614aec563103b4d4702f3ba7d4d2698e22c158\"\n Created: 1371157430\n CreatedBy: \"\"\n Tags:\n - \"scratch12:latest\"\n - \"scratch:latest\"\n Size: 0\n Comment: \"Imported from -\"\n 404:\n description: \"No such image\"\n schema:\n $ref: \"#/definitions/ErrorResponse\"\n 500:\n description: \"Server error\"\n schema:\n $ref: \"#/definitions/ErrorResponse\"\n parameters:\n - name: \"name\"\n in: \"path\"\n description: \"Image name or ID\"\n type: \"string\"\n required: true\n tags: [\"Image\"]\n /images/{name}/push:\n post:\n summary: \"Push an image\"\n description: |\n Push an image to a registry.\n\n If you wish to push an image on to a private registry, that image must\n already have a tag which references the registry. For example,\n `registry.example.com/myimage:latest`.\n\n The push is cancelled if the HTTP connection is closed.\n operationId: \"ImagePush\"\n consumes:\n - \"application/octet-stream\"\n responses:\n 200:\n description: \"No error\"\n 404:\n description: \"No such image\"\n schema:\n $ref: \"#/definitions/ErrorResponse\"\n 500:\n description: \"Server error\"\n schema:\n $ref: \"#/definitions/ErrorResponse\"\n parameters:\n - name: \"name\"\n in: \"path\"\n description: \"Image name or ID.\"\n type: \"string\"\n required: true\n - name: \"tag\"\n in: \"query\"\n description: \"The tag to associate with the image on the registry.\"\n type: \"string\"\n - name: \"X-Registry-Auth\"\n in: \"header\"\n description: |\n A base64url-encoded auth configuration.\n\n Refer to the [authentication section](#section/Authentication) for\n details.\n type: \"string\"\n required: true\n tags: [\"Image\"]\n /images/{name}/tag:\n post:\n summary: \"Tag an image\"\n description: \"Tag an image so that it becomes part of a repository.\"\n operationId: \"ImageTag\"\n responses:\n 201:\n description: \"No error\"\n 400:\n description: \"Bad parameter\"\n schema:\n $ref: \"#/definitions/ErrorResponse\"\n 404:\n description: \"No such image\"\n schema:\n $ref: \"#/definitions/ErrorResponse\"\n 409:\n description: \"Conflict\"\n schema:\n $ref: \"#/definitions/ErrorResponse\"\n 500:\n description: \"Server error\"\n schema:\n $ref: \"#/definitions/ErrorResponse\"\n parameters:\n - name: \"name\"\n in: \"path\"\n description: \"Image name or ID to tag.\"\n type: \"string\"\n required: true\n - name: \"repo\"\n in: \"query\"\n description: \"The repository to tag in. For example, `someuser/someimage`.\"\n type: \"string\"\n - name: \"tag\"\n in: \"query\"\n description: \"The name of the new tag.\"\n type: \"string\"\n tags: [\"Image\"]\n /images/{name}:\n delete:\n summary: \"Remove an image\"\n description: |\n Remove an image, along with any untagged parent images that were\n referenced by that image.\n\n Images can't be removed if they have descendant images, are being\n used by a running container or are being used by a build.\n operationId: \"ImageDelete\"\n produces: [\"application/json\"]\n responses:\n 200:\n description: \"The image was deleted successfully\"\n schema:\n type: \"array\"\n items:\n $ref: \"#/definitions/ImageDeleteResponseItem\"\n examples:\n application/json:\n - Untagged: \"3e2f21a89f\"\n - Deleted: \"3e2f21a89f\"\n - Deleted: \"53b4f83ac9\"\n 404:\n description: \"No such image\"\n schema:\n $ref: \"#/definitions/ErrorResponse\"\n 409:\n description: \"Conflict\"\n schema:\n $ref: \"#/definitions/ErrorResponse\"\n 500:\n description: \"Server error\"\n schema:\n $ref: \"#/definitions/ErrorResponse\"\n parameters:\n - name: \"name\"\n in: \"path\"\n description: \"Image name or ID\"\n type: \"string\"\n required: true\n - name: \"force\"\n in: \"query\"\n description: \"Remove the image even if it is being used by stopped containers or has other tags\"\n type: \"boolean\"\n default: false\n - name: \"noprune\"\n in: \"query\"\n description: \"Do not delete untagged parent images\"\n type: \"boolean\"\n default: false\n tags: [\"Image\"]\n /images/search:\n get:\n summary: \"Search images\"\n description: \"Search for an image on Docker Hub.\"\n operationId: \"ImageSearch\"\n produces:\n - \"application/json\"\n responses:\n 200:\n description: \"No error\"\n schema:\n type: \"array\"\n items:\n type: \"object\"\n title: \"ImageSearchResponseItem\"\n properties:\n description:\n type: \"string\"\n is_official:\n type: \"boolean\"\n is_automated:\n type: \"boolean\"\n name:\n type: \"string\"\n star_count:\n type: \"integer\"\n examples:\n application/json:\n - description: \"\"\n is_official: false\n is_automated: false\n name: \"wma55/u1210sshd\"\n star_count: 0\n - description: \"\"\n is_official: false\n is_automated: false\n name: \"jdswinbank/sshd\"\n star_count: 0\n - description: \"\"\n is_official: false\n is_automated: false\n name: \"vgauthier/sshd\"\n star_count: 0\n 500:\n description: \"Server error\"\n schema:\n $ref: \"#/definitions/ErrorResponse\"\n parameters:\n - name: \"term\"\n in: \"query\"\n description: \"Term to search\"\n type: \"string\"\n required: true\n - name: \"limit\"\n in: \"query\"\n description: \"Maximum number of results to return\"\n type: \"integer\"\n - name: \"filters\"\n in: \"query\"\n description: |\n A JSON encoded value of the filters (a `map[string][]string`) to process on the images list. Available filters:\n\n - `is-automated=(true|false)`\n - `is-official=(true|false)`\n - `stars=` Matches images that has at least 'number' stars.\n type: \"string\"\n tags: [\"Image\"]\n /images/prune:\n post:\n summary: \"Delete unused images\"\n produces:\n - \"application/json\"\n operationId: \"ImagePrune\"\n parameters:\n - name: \"filters\"\n in: \"query\"\n description: |\n Filters to process on the prune list, encoded as JSON (a `map[string][]string`). Available filters:\n\n - `dangling=` When set to `true` (or `1`), prune only\n unused *and* untagged images. When set to `false`\n (or `0`), all unused images are pruned.\n - `until=` Prune images created before this timestamp. The `` can be Unix timestamps, date formatted timestamps, or Go duration strings (e.g. `10m`, `1h30m`) computed relative to the daemon machine’s time.\n - `label` (`label=`, `label==`, `label!=`, or `label!==`) Prune images with (or without, in case `label!=...` is used) the specified labels.\n type: \"string\"\n responses:\n 200:\n description: \"No error\"\n schema:\n type: \"object\"\n title: \"ImagePruneResponse\"\n properties:\n ImagesDeleted:\n description: \"Images that were deleted\"\n type: \"array\"\n items:\n $ref: \"#/definitions/ImageDeleteResponseItem\"\n SpaceReclaimed:\n description: \"Disk space reclaimed in bytes\"\n type: \"integer\"\n format: \"int64\"\n 500:\n description: \"Server error\"\n schema:\n $ref: \"#/definitions/ErrorResponse\"\n tags: [\"Image\"]\n /auth:\n post:\n summary: \"Check auth configuration\"\n description: |\n Validate credentials for a registry and, if available, get an identity\n token for accessing the registry without password.\n operationId: \"SystemAuth\"\n consumes: [\"application/json\"]\n produces: [\"application/json\"]\n responses:\n 200:\n description: \"An identity token was generated successfully.\"\n schema:\n type: \"object\"\n title: \"SystemAuthResponse\"\n required: [Status]\n properties:\n Status:\n description: \"The status of the authentication\"\n type: \"string\"\n x-nullable: false\n IdentityToken:\n description: \"An opaque token used to authenticate a user after a successful login\"\n type: \"string\"\n x-nullable: false\n examples:\n application/json:\n Status: \"Login Succeeded\"\n IdentityToken: \"9cbaf023786cd7...\"\n 204:\n description: \"No error\"\n 500:\n description: \"Server error\"\n schema:\n $ref: \"#/definitions/ErrorResponse\"\n parameters:\n - name: \"authConfig\"\n in: \"body\"\n description: \"Authentication to check\"\n schema:\n $ref: \"#/definitions/AuthConfig\"\n tags: [\"System\"]\n /info:\n get:\n summary: \"Get system information\"\n operationId: \"SystemInfo\"\n produces:\n - \"application/json\"\n responses:\n 200:\n description: \"No error\"\n schema:\n $ref: \"#/definitions/SystemInfo\"\n 500:\n description: \"Server error\"\n schema:\n $ref: \"#/definitions/ErrorResponse\"\n tags: [\"System\"]\n /version:\n get:\n summary: \"Get version\"\n description: \"Returns the version of Docker that is running and various information about the system that Docker is running on.\"\n operationId: \"SystemVersion\"\n produces: [\"application/json\"]\n responses:\n 200:\n description: \"no error\"\n schema:\n $ref: \"#/definitions/SystemVersion\"\n 500:\n description: \"server error\"\n schema:\n $ref: \"#/definitions/ErrorResponse\"\n tags: [\"System\"]\n /_ping:\n get:\n summary: \"Ping\"\n description: \"This is a dummy endpoint you can use to test if the server is accessible.\"\n operationId: \"SystemPing\"\n produces: [\"text/plain\"]\n responses:\n 200:\n description: \"no error\"\n schema:\n type: \"string\"\n example: \"OK\"\n headers:\n API-Version:\n type: \"string\"\n description: \"Max API Version the server supports\"\n Builder-Version:\n type: \"string\"\n description: \"Default version of docker image builder\"\n Docker-Experimental:\n type: \"boolean\"\n description: \"If the server is running with experimental mode enabled\"\n Cache-Control:\n type: \"string\"\n default: \"no-cache, no-store, must-revalidate\"\n Pragma:\n type: \"string\"\n default: \"no-cache\"\n 500:\n description: \"server error\"\n schema:\n $ref: \"#/definitions/ErrorResponse\"\n headers:\n Cache-Control:\n type: \"string\"\n default: \"no-cache, no-store, must-revalidate\"\n Pragma:\n type: \"string\"\n default: \"no-cache\"\n tags: [\"System\"]\n head:\n summary: \"Ping\"\n description: \"This is a dummy endpoint you can use to test if the server is accessible.\"\n operationId: \"SystemPingHead\"\n produces: [\"text/plain\"]\n responses:\n 200:\n description: \"no error\"\n schema:\n type: \"string\"\n example: \"(empty)\"\n headers:\n API-Version:\n type: \"string\"\n description: \"Max API Version the server supports\"\n Builder-Version:\n type: \"string\"\n description: \"Default version of docker image builder\"\n Docker-Experimental:\n type: \"boolean\"\n description: \"If the server is running with experimental mode enabled\"\n Cache-Control:\n type: \"string\"\n default: \"no-cache, no-store, must-revalidate\"\n Pragma:\n type: \"string\"\n default: \"no-cache\"\n 500:\n description: \"server error\"\n schema:\n $ref: \"#/definitions/ErrorResponse\"\n tags: [\"System\"]\n /commit:\n post:\n summary: \"Create a new image from a container\"\n operationId: \"ImageCommit\"\n consumes:\n - \"application/json\"\n produces:\n - \"application/json\"\n responses:\n 201:\n description: \"no error\"\n schema:\n $ref: \"#/definitions/IdResponse\"\n 404:\n description: \"no such container\"\n schema:\n $ref: \"#/definitions/ErrorResponse\"\n examples:\n application/json:\n message: \"No such container: c2ada9df5af8\"\n 500:\n description: \"server error\"\n schema:\n $ref: \"#/definitions/ErrorResponse\"\n parameters:\n - name: \"containerConfig\"\n in: \"body\"\n description: \"The container configuration\"\n schema:\n $ref: \"#/definitions/ContainerConfig\"\n - name: \"container\"\n in: \"query\"\n description: \"The ID or name of the container to commit\"\n type: \"string\"\n - name: \"repo\"\n in: \"query\"\n description: \"Repository name for the created image\"\n type: \"string\"\n - name: \"tag\"\n in: \"query\"\n description: \"Tag name for the create image\"\n type: \"string\"\n - name: \"comment\"\n in: \"query\"\n description: \"Commit message\"\n type: \"string\"\n - name: \"author\"\n in: \"query\"\n description: \"Author of the image (e.g., `John Hannibal Smith `)\"\n type: \"string\"\n - name: \"pause\"\n in: \"query\"\n description: \"Whether to pause the container before committing\"\n type: \"boolean\"\n default: true\n - name: \"changes\"\n in: \"query\"\n description: \"`Dockerfile` instructions to apply while committing\"\n type: \"string\"\n tags: [\"Image\"]\n /events:\n get:\n summary: \"Monitor events\"\n description: |\n Stream real-time events from the server.\n\n Various objects within Docker report events when something happens to them.\n\n Containers report these events: `attach`, `commit`, `copy`, `create`, `destroy`, `detach`, `die`, `exec_create`, `exec_detach`, `exec_start`, `exec_die`, `export`, `health_status`, `kill`, `oom`, `pause`, `rename`, `resize`, `restart`, `start`, `stop`, `top`, `unpause`, `update`, and `prune`\n\n Images report these events: `delete`, `import`, `load`, `pull`, `push`, `save`, `tag`, `untag`, and `prune`\n\n Volumes report these events: `create`, `mount`, `unmount`, `destroy`, and `prune`\n\n Networks report these events: `create`, `connect`, `disconnect`, `destroy`, `update`, `remove`, and `prune`\n\n The Docker daemon reports these events: `reload`\n\n Services report these events: `create`, `update`, and `remove`\n\n Nodes report these events: `create`, `update`, and `remove`\n\n Secrets report these events: `create`, `update`, and `remove`\n\n Configs report these events: `create`, `update`, and `remove`\n\n The Builder reports `prune` events\n\n operationId: \"SystemEvents\"\n produces:\n - \"application/json\"\n responses:\n 200:\n description: \"no error\"\n schema:\n type: \"object\"\n title: \"SystemEventsResponse\"\n properties:\n Type:\n description: \"The type of object emitting the event\"\n type: \"string\"\n Action:\n description: \"The type of event\"\n type: \"string\"\n Actor:\n type: \"object\"\n properties:\n ID:\n description: \"The ID of the object emitting the event\"\n type: \"string\"\n Attributes:\n description: \"Various key/value attributes of the object, depending on its type\"\n type: \"object\"\n additionalProperties:\n type: \"string\"\n time:\n description: \"Timestamp of event\"\n type: \"integer\"\n timeNano:\n description: \"Timestamp of event, with nanosecond accuracy\"\n type: \"integer\"\n format: \"int64\"\n examples:\n application/json:\n Type: \"container\"\n Action: \"create\"\n Actor:\n ID: \"ede54ee1afda366ab42f824e8a5ffd195155d853ceaec74a927f249ea270c743\"\n Attributes:\n com.example.some-label: \"some-label-value\"\n image: \"alpine\"\n name: \"my-container\"\n time: 1461943101\n 400:\n description: \"bad parameter\"\n schema:\n $ref: \"#/definitions/ErrorResponse\"\n 500:\n description: \"server error\"\n schema:\n $ref: \"#/definitions/ErrorResponse\"\n parameters:\n - name: \"since\"\n in: \"query\"\n description: \"Show events created since this timestamp then stream new events.\"\n type: \"string\"\n - name: \"until\"\n in: \"query\"\n description: \"Show events created until this timestamp then stop streaming.\"\n type: \"string\"\n - name: \"filters\"\n in: \"query\"\n description: |\n A JSON encoded value of filters (a `map[string][]string`) to process on the event list. Available filters:\n\n - `config=` config name or ID\n - `container=` container name or ID\n - `daemon=` daemon name or ID\n - `event=` event type\n - `image=` image name or ID\n - `label=` image or container label\n - `network=` network name or ID\n - `node=` node ID\n - `plugin`= plugin name or ID\n - `scope`= local or swarm\n - `secret=` secret name or ID\n - `service=` service name or ID\n - `type=` object to filter by, one of `container`, `image`, `volume`, `network`, `daemon`, `plugin`, `node`, `service`, `secret` or `config`\n - `volume=` volume name\n type: \"string\"\n tags: [\"System\"]\n /system/df:\n get:\n summary: \"Get data usage information\"\n operationId: \"SystemDataUsage\"\n responses:\n 200:\n description: \"no error\"\n schema:\n type: \"object\"\n title: \"SystemDataUsageResponse\"\n properties:\n LayersSize:\n type: \"integer\"\n format: \"int64\"\n Images:\n type: \"array\"\n items:\n $ref: \"#/definitions/ImageSummary\"\n Containers:\n type: \"array\"\n items:\n $ref: \"#/definitions/ContainerSummary\"\n Volumes:\n type: \"array\"\n items:\n $ref: \"#/definitions/Volume\"\n BuildCache:\n type: \"array\"\n items:\n $ref: \"#/definitions/BuildCache\"\n example:\n LayersSize: 1092588\n Images:\n -\n Id: \"sha256:2b8fd9751c4c0f5dd266fcae00707e67a2545ef34f9a29354585f93dac906749\"\n ParentId: \"\"\n RepoTags:\n - \"busybox:latest\"\n RepoDigests:\n - \"busybox@sha256:a59906e33509d14c036c8678d687bd4eec81ed7c4b8ce907b888c607f6a1e0e6\"\n Created: 1466724217\n Size: 1092588\n SharedSize: 0\n VirtualSize: 1092588\n Labels: {}\n Containers: 1\n Containers:\n -\n Id: \"e575172ed11dc01bfce087fb27bee502db149e1a0fad7c296ad300bbff178148\"\n Names:\n - \"/top\"\n Image: \"busybox\"\n ImageID: \"sha256:2b8fd9751c4c0f5dd266fcae00707e67a2545ef34f9a29354585f93dac906749\"\n Command: \"top\"\n Created: 1472592424\n Ports: []\n SizeRootFs: 1092588\n Labels: {}\n State: \"exited\"\n Status: \"Exited (0) 56 minutes ago\"\n HostConfig:\n NetworkMode: \"default\"\n NetworkSettings:\n Networks:\n bridge:\n IPAMConfig: null\n Links: null\n Aliases: null\n NetworkID: \"d687bc59335f0e5c9ee8193e5612e8aee000c8c62ea170cfb99c098f95899d92\"\n EndpointID: \"8ed5115aeaad9abb174f68dcf135b49f11daf597678315231a32ca28441dec6a\"\n Gateway: \"172.18.0.1\"\n IPAddress: \"172.18.0.2\"\n IPPrefixLen: 16\n IPv6Gateway: \"\"\n GlobalIPv6Address: \"\"\n GlobalIPv6PrefixLen: 0\n MacAddress: \"02:42:ac:12:00:02\"\n Mounts: []\n Volumes:\n -\n Name: \"my-volume\"\n Driver: \"local\"\n Mountpoint: \"/var/lib/docker/volumes/my-volume/_data\"\n Labels: null\n Scope: \"local\"\n Options: null\n UsageData:\n Size: 10920104\n RefCount: 2\n BuildCache:\n -\n ID: \"hw53o5aio51xtltp5xjp8v7fx\"\n Parent: \"\"\n Type: \"regular\"\n Description: \"pulled from docker.io/library/debian@sha256:234cb88d3020898631af0ccbbcca9a66ae7306ecd30c9720690858c1b007d2a0\"\n InUse: false\n Shared: true\n Size: 0\n CreatedAt: \"2021-06-28T13:31:01.474619385Z\"\n LastUsedAt: \"2021-07-07T22:02:32.738075951Z\"\n UsageCount: 26\n -\n ID: \"ndlpt0hhvkqcdfkputsk4cq9c\"\n Parent: \"hw53o5aio51xtltp5xjp8v7fx\"\n Type: \"regular\"\n Description: \"mount / from exec /bin/sh -c echo 'Binary::apt::APT::Keep-Downloaded-Packages \\\"true\\\";' > /etc/apt/apt.conf.d/keep-cache\"\n InUse: false\n Shared: true\n Size: 51\n CreatedAt: \"2021-06-28T13:31:03.002625487Z\"\n LastUsedAt: \"2021-07-07T22:02:32.773909517Z\"\n UsageCount: 26\n 500:\n description: \"server error\"\n schema:\n $ref: \"#/definitions/ErrorResponse\"\n parameters:\n - name: \"type\"\n in: \"query\"\n description: |\n Object types, for which to compute and return data.\n type: \"array\"\n collectionFormat: multi\n items:\n type: \"string\"\n enum: [\"container\", \"image\", \"volume\", \"build-cache\"]\n tags: [\"System\"]\n /images/{name}/get:\n get:\n summary: \"Export an image\"\n description: |\n Get a tarball containing all images and metadata for a repository.\n\n If `name` is a specific name and tag (e.g. `ubuntu:latest`), then only that image (and its parents) are returned. If `name` is an image ID, similarly only that image (and its parents) are returned, but with the exclusion of the `repositories` file in the tarball, as there were no image names referenced.\n\n ### Image tarball format\n\n An image tarball contains one directory per image layer (named using its long ID), each containing these files:\n\n - `VERSION`: currently `1.0` - the file format version\n - `json`: detailed layer information, similar to `docker inspect layer_id`\n - `layer.tar`: A tarfile containing the filesystem changes in this layer\n\n The `layer.tar` file contains `aufs` style `.wh..wh.aufs` files and directories for storing attribute changes and deletions.\n\n If the tarball defines a repository, the tarball should also include a `repositories` file at the root that contains a list of repository and tag names mapped to layer IDs.\n\n ```json\n {\n \"hello-world\": {\n \"latest\": \"565a9d68a73f6706862bfe8409a7f659776d4d60a8d096eb4a3cbce6999cc2a1\"\n }\n }\n ```\n operationId: \"ImageGet\"\n produces:\n - \"application/x-tar\"\n responses:\n 200:\n description: \"no error\"\n schema:\n type: \"string\"\n format: \"binary\"\n 500:\n description: \"server error\"\n schema:\n $ref: \"#/definitions/ErrorResponse\"\n parameters:\n - name: \"name\"\n in: \"path\"\n description: \"Image name or ID\"\n type: \"string\"\n required: true\n tags: [\"Image\"]\n /images/get:\n get:\n summary: \"Export several images\"\n description: |\n Get a tarball containing all images and metadata for several image\n repositories.\n\n For each value of the `names` parameter: if it is a specific name and\n tag (e.g. `ubuntu:latest`), then only that image (and its parents) are\n returned; if it is an image ID, similarly only that image (and its parents)\n are returned and there would be no names referenced in the 'repositories'\n file for this image ID.\n\n For details on the format, see the [export image endpoint](#operation/ImageGet).\n operationId: \"ImageGetAll\"\n produces:\n - \"application/x-tar\"\n responses:\n 200:\n description: \"no error\"\n schema:\n type: \"string\"\n format: \"binary\"\n 500:\n description: \"server error\"\n schema:\n $ref: \"#/definitions/ErrorResponse\"\n parameters:\n - name: \"names\"\n in: \"query\"\n description: \"Image names to filter by\"\n type: \"array\"\n items:\n type: \"string\"\n tags: [\"Image\"]\n /images/load:\n post:\n summary: \"Import images\"\n description: |\n Load a set of images and tags into a repository.\n\n For details on the format, see the [export image endpoint](#operation/ImageGet).\n operationId: \"ImageLoad\"\n consumes:\n - \"application/x-tar\"\n produces:\n - \"application/json\"\n responses:\n 200:\n description: \"no error\"\n 500:\n description: \"server error\"\n schema:\n $ref: \"#/definitions/ErrorResponse\"\n parameters:\n - name: \"imagesTarball\"\n in: \"body\"\n description: \"Tar archive containing images\"\n schema:\n type: \"string\"\n format: \"binary\"\n - name: \"quiet\"\n in: \"query\"\n description: \"Suppress progress details during load.\"\n type: \"boolean\"\n default: false\n tags: [\"Image\"]\n /containers/{id}/exec:\n post:\n summary: \"Create an exec instance\"\n description: \"Run a command inside a running container.\"\n operationId: \"ContainerExec\"\n consumes:\n - \"application/json\"\n produces:\n - \"application/json\"\n responses:\n 201:\n description: \"no error\"\n schema:\n $ref: \"#/definitions/IdResponse\"\n 404:\n description: \"no such container\"\n schema:\n $ref: \"#/definitions/ErrorResponse\"\n examples:\n application/json:\n message: \"No such container: c2ada9df5af8\"\n 409:\n description: \"container is paused\"\n schema:\n $ref: \"#/definitions/ErrorResponse\"\n 500:\n description: \"Server error\"\n schema:\n $ref: \"#/definitions/ErrorResponse\"\n parameters:\n - name: \"execConfig\"\n in: \"body\"\n description: \"Exec configuration\"\n schema:\n type: \"object\"\n title: \"ExecConfig\"\n properties:\n AttachStdin:\n type: \"boolean\"\n description: \"Attach to `stdin` of the exec command.\"\n AttachStdout:\n type: \"boolean\"\n description: \"Attach to `stdout` of the exec command.\"\n AttachStderr:\n type: \"boolean\"\n description: \"Attach to `stderr` of the exec command.\"\n DetachKeys:\n type: \"string\"\n description: |\n Override the key sequence for detaching a container. Format is\n a single character `[a-Z]` or `ctrl-` where ``\n is one of: `a-z`, `@`, `^`, `[`, `,` or `_`.\n Tty:\n type: \"boolean\"\n description: \"Allocate a pseudo-TTY.\"\n Env:\n description: |\n A list of environment variables in the form `[\"VAR=value\", ...]`.\n type: \"array\"\n items:\n type: \"string\"\n Cmd:\n type: \"array\"\n description: \"Command to run, as a string or array of strings.\"\n items:\n type: \"string\"\n Privileged:\n type: \"boolean\"\n description: \"Runs the exec process with extended privileges.\"\n default: false\n User:\n type: \"string\"\n description: |\n The user, and optionally, group to run the exec process inside\n the container. Format is one of: `user`, `user:group`, `uid`,\n or `uid:gid`.\n WorkingDir:\n type: \"string\"\n description: |\n The working directory for the exec process inside the container.\n example:\n AttachStdin: false\n AttachStdout: true\n AttachStderr: true\n DetachKeys: \"ctrl-p,ctrl-q\"\n Tty: false\n Cmd:\n - \"date\"\n Env:\n - \"FOO=bar\"\n - \"BAZ=quux\"\n required: true\n - name: \"id\"\n in: \"path\"\n description: \"ID or name of container\"\n type: \"string\"\n required: true\n tags: [\"Exec\"]\n /exec/{id}/start:\n post:\n summary: \"Start an exec instance\"\n description: |\n Starts a previously set up exec instance. If detach is true, this endpoint\n returns immediately after starting the command. Otherwise, it sets up an\n interactive session with the command.\n operationId: \"ExecStart\"\n consumes:\n - \"application/json\"\n produces:\n - \"application/vnd.docker.raw-stream\"\n responses:\n 200:\n description: \"No error\"\n 404:\n description: \"No such exec instance\"\n schema:\n $ref: \"#/definitions/ErrorResponse\"\n 409:\n description: \"Container is stopped or paused\"\n schema:\n $ref: \"#/definitions/ErrorResponse\"\n parameters:\n - name: \"execStartConfig\"\n in: \"body\"\n schema:\n type: \"object\"\n title: \"ExecStartConfig\"\n properties:\n Detach:\n type: \"boolean\"\n description: \"Detach from the command.\"\n Tty:\n type: \"boolean\"\n description: \"Allocate a pseudo-TTY.\"\n example:\n Detach: false\n Tty: false\n - name: \"id\"\n in: \"path\"\n description: \"Exec instance ID\"\n required: true\n type: \"string\"\n tags: [\"Exec\"]\n /exec/{id}/resize:\n post:\n summary: \"Resize an exec instance\"\n description: |\n Resize the TTY session used by an exec instance. This endpoint only works\n if `tty` was specified as part of creating and starting the exec instance.\n operationId: \"ExecResize\"\n responses:\n 201:\n description: \"No error\"\n 404:\n description: \"No such exec instance\"\n schema:\n $ref: \"#/definitions/ErrorResponse\"\n parameters:\n - name: \"id\"\n in: \"path\"\n description: \"Exec instance ID\"\n required: true\n type: \"string\"\n - name: \"h\"\n in: \"query\"\n description: \"Height of the TTY session in characters\"\n type: \"integer\"\n - name: \"w\"\n in: \"query\"\n description: \"Width of the TTY session in characters\"\n type: \"integer\"\n tags: [\"Exec\"]\n /exec/{id}/json:\n get:\n summary: \"Inspect an exec instance\"\n description: \"Return low-level information about an exec instance.\"\n operationId: \"ExecInspect\"\n produces:\n - \"application/json\"\n responses:\n 200:\n description: \"No error\"\n schema:\n type: \"object\"\n title: \"ExecInspectResponse\"\n properties:\n CanRemove:\n type: \"boolean\"\n DetachKeys:\n type: \"string\"\n ID:\n type: \"string\"\n Running:\n type: \"boolean\"\n ExitCode:\n type: \"integer\"\n ProcessConfig:\n $ref: \"#/definitions/ProcessConfig\"\n OpenStdin:\n type: \"boolean\"\n OpenStderr:\n type: \"boolean\"\n OpenStdout:\n type: \"boolean\"\n ContainerID:\n type: \"string\"\n Pid:\n type: \"integer\"\n description: \"The system process ID for the exec process.\"\n examples:\n application/json:\n CanRemove: false\n ContainerID: \"b53ee82b53a40c7dca428523e34f741f3abc51d9f297a14ff874bf761b995126\"\n DetachKeys: \"\"\n ExitCode: 2\n ID: \"f33bbfb39f5b142420f4759b2348913bd4a8d1a6d7fd56499cb41a1bb91d7b3b\"\n OpenStderr: true\n OpenStdin: true\n OpenStdout: true\n ProcessConfig:\n arguments:\n - \"-c\"\n - \"exit 2\"\n entrypoint: \"sh\"\n privileged: false\n tty: true\n user: \"1000\"\n Running: false\n Pid: 42000\n 404:\n description: \"No such exec instance\"\n schema:\n $ref: \"#/definitions/ErrorResponse\"\n 500:\n description: \"Server error\"\n schema:\n $ref: \"#/definitions/ErrorResponse\"\n parameters:\n - name: \"id\"\n in: \"path\"\n description: \"Exec instance ID\"\n required: true\n type: \"string\"\n tags: [\"Exec\"]\n\n /volumes:\n get:\n summary: \"List volumes\"\n operationId: \"VolumeList\"\n produces: [\"application/json\"]\n responses:\n 200:\n description: \"Summary volume data that matches the query\"\n schema:\n type: \"object\"\n title: \"VolumeListResponse\"\n description: \"Volume list response\"\n required: [Volumes, Warnings]\n properties:\n Volumes:\n type: \"array\"\n x-nullable: false\n description: \"List of volumes\"\n items:\n $ref: \"#/definitions/Volume\"\n Warnings:\n type: \"array\"\n x-nullable: false\n description: |\n Warnings that occurred when fetching the list of volumes.\n items:\n type: \"string\"\n\n examples:\n application/json:\n Volumes:\n - CreatedAt: \"2017-07-19T12:00:26Z\"\n Name: \"tardis\"\n Driver: \"local\"\n Mountpoint: \"/var/lib/docker/volumes/tardis\"\n Labels:\n com.example.some-label: \"some-value\"\n com.example.some-other-label: \"some-other-value\"\n Scope: \"local\"\n Options:\n device: \"tmpfs\"\n o: \"size=100m,uid=1000\"\n type: \"tmpfs\"\n Warnings: []\n 500:\n description: \"Server error\"\n schema:\n $ref: \"#/definitions/ErrorResponse\"\n parameters:\n - name: \"filters\"\n in: \"query\"\n description: |\n JSON encoded value of the filters (a `map[string][]string`) to\n process on the volumes list. Available filters:\n\n - `dangling=` When set to `true` (or `1`), returns all\n volumes that are not in use by a container. When set to `false`\n (or `0`), only volumes that are in use by one or more\n containers are returned.\n - `driver=` Matches volumes based on their driver.\n - `label=` or `label=:` Matches volumes based on\n the presence of a `label` alone or a `label` and a value.\n - `name=` Matches all or part of a volume name.\n type: \"string\"\n format: \"json\"\n tags: [\"Volume\"]\n\n /volumes/create:\n post:\n summary: \"Create a volume\"\n operationId: \"VolumeCreate\"\n consumes: [\"application/json\"]\n produces: [\"application/json\"]\n responses:\n 201:\n description: \"The volume was created successfully\"\n schema:\n $ref: \"#/definitions/Volume\"\n 500:\n description: \"Server error\"\n schema:\n $ref: \"#/definitions/ErrorResponse\"\n parameters:\n - name: \"volumeConfig\"\n in: \"body\"\n required: true\n description: \"Volume configuration\"\n schema:\n type: \"object\"\n description: \"Volume configuration\"\n title: \"VolumeConfig\"\n properties:\n Name:\n description: |\n The new volume's name. If not specified, Docker generates a name.\n type: \"string\"\n x-nullable: false\n Driver:\n description: \"Name of the volume driver to use.\"\n type: \"string\"\n default: \"local\"\n x-nullable: false\n DriverOpts:\n description: |\n A mapping of driver options and values. These options are\n passed directly to the driver and are driver specific.\n type: \"object\"\n additionalProperties:\n type: \"string\"\n Labels:\n description: \"User-defined key/value metadata.\"\n type: \"object\"\n additionalProperties:\n type: \"string\"\n example:\n Name: \"tardis\"\n Labels:\n com.example.some-label: \"some-value\"\n com.example.some-other-label: \"some-other-value\"\n Driver: \"custom\"\n tags: [\"Volume\"]\n\n /volumes/{name}:\n get:\n summary: \"Inspect a volume\"\n operationId: \"VolumeInspect\"\n produces: [\"application/json\"]\n responses:\n 200:\n description: \"No error\"\n schema:\n $ref: \"#/definitions/Volume\"\n 404:\n description: \"No such volume\"\n schema:\n $ref: \"#/definitions/ErrorResponse\"\n 500:\n description: \"Server error\"\n schema:\n $ref: \"#/definitions/ErrorResponse\"\n parameters:\n - name: \"name\"\n in: \"path\"\n required: true\n description: \"Volume name or ID\"\n type: \"string\"\n tags: [\"Volume\"]\n\n delete:\n summary: \"Remove a volume\"\n description: \"Instruct the driver to remove the volume.\"\n operationId: \"VolumeDelete\"\n responses:\n 204:\n description: \"The volume was removed\"\n 404:\n description: \"No such volume or volume driver\"\n schema:\n $ref: \"#/definitions/ErrorResponse\"\n 409:\n description: \"Volume is in use and cannot be removed\"\n schema:\n $ref: \"#/definitions/ErrorResponse\"\n 500:\n description: \"Server error\"\n schema:\n $ref: \"#/definitions/ErrorResponse\"\n parameters:\n - name: \"name\"\n in: \"path\"\n required: true\n description: \"Volume name or ID\"\n type: \"string\"\n - name: \"force\"\n in: \"query\"\n description: \"Force the removal of the volume\"\n type: \"boolean\"\n default: false\n tags: [\"Volume\"]\n /volumes/prune:\n post:\n summary: \"Delete unused volumes\"\n produces:\n - \"application/json\"\n operationId: \"VolumePrune\"\n parameters:\n - name: \"filters\"\n in: \"query\"\n description: |\n Filters to process on the prune list, encoded as JSON (a `map[string][]string`).\n\n Available filters:\n - `label` (`label=`, `label==`, `label!=`, or `label!==`) Prune volumes with (or without, in case `label!=...` is used) the specified labels.\n type: \"string\"\n responses:\n 200:\n description: \"No error\"\n schema:\n type: \"object\"\n title: \"VolumePruneResponse\"\n properties:\n VolumesDeleted:\n description: \"Volumes that were deleted\"\n type: \"array\"\n items:\n type: \"string\"\n SpaceReclaimed:\n description: \"Disk space reclaimed in bytes\"\n type: \"integer\"\n format: \"int64\"\n 500:\n description: \"Server error\"\n schema:\n $ref: \"#/definitions/ErrorResponse\"\n tags: [\"Volume\"]\n /networks:\n get:\n summary: \"List networks\"\n description: |\n Returns a list of networks. For details on the format, see the\n [network inspect endpoint](#operation/NetworkInspect).\n\n Note that it uses a different, smaller representation of a network than\n inspecting a single network. For example, the list of containers attached\n to the network is not propagated in API versions 1.28 and up.\n operationId: \"NetworkList\"\n produces:\n - \"application/json\"\n responses:\n 200:\n description: \"No error\"\n schema:\n type: \"array\"\n items:\n $ref: \"#/definitions/Network\"\n examples:\n application/json:\n - Name: \"bridge\"\n Id: \"f2de39df4171b0dc801e8002d1d999b77256983dfc63041c0f34030aa3977566\"\n Created: \"2016-10-19T06:21:00.416543526Z\"\n Scope: \"local\"\n Driver: \"bridge\"\n EnableIPv6: false\n Internal: false\n Attachable: false\n Ingress: false\n IPAM:\n Driver: \"default\"\n Config:\n -\n Subnet: \"172.17.0.0/16\"\n Options:\n com.docker.network.bridge.default_bridge: \"true\"\n com.docker.network.bridge.enable_icc: \"true\"\n com.docker.network.bridge.enable_ip_masquerade: \"true\"\n com.docker.network.bridge.host_binding_ipv4: \"0.0.0.0\"\n com.docker.network.bridge.name: \"docker0\"\n com.docker.network.driver.mtu: \"1500\"\n - Name: \"none\"\n Id: \"e086a3893b05ab69242d3c44e49483a3bbbd3a26b46baa8f61ab797c1088d794\"\n Created: \"0001-01-01T00:00:00Z\"\n Scope: \"local\"\n Driver: \"null\"\n EnableIPv6: false\n Internal: false\n Attachable: false\n Ingress: false\n IPAM:\n Driver: \"default\"\n Config: []\n Containers: {}\n Options: {}\n - Name: \"host\"\n Id: \"13e871235c677f196c4e1ecebb9dc733b9b2d2ab589e30c539efeda84a24215e\"\n Created: \"0001-01-01T00:00:00Z\"\n Scope: \"local\"\n Driver: \"host\"\n EnableIPv6: false\n Internal: false\n Attachable: false\n Ingress: false\n IPAM:\n Driver: \"default\"\n Config: []\n Containers: {}\n Options: {}\n 500:\n description: \"Server error\"\n schema:\n $ref: \"#/definitions/ErrorResponse\"\n parameters:\n - name: \"filters\"\n in: \"query\"\n description: |\n JSON encoded value of the filters (a `map[string][]string`) to process\n on the networks list.\n\n Available filters:\n\n - `dangling=` When set to `true` (or `1`), returns all\n networks that are not in use by a container. When set to `false`\n (or `0`), only networks that are in use by one or more\n containers are returned.\n - `driver=` Matches a network's driver.\n - `id=` Matches all or part of a network ID.\n - `label=` or `label==
\n\n > **Note**: `Configs.File` and `Configs.Runtime` are mutually exclusive\n type: \"object\"\n properties:\n Name:\n description: |\n Name represents the final filename in the filesystem.\n type: \"string\"\n UID:\n description: \"UID represents the file UID.\"\n type: \"string\"\n GID:\n description: \"GID represents the file GID.\"\n type: \"string\"\n Mode:\n description: \"Mode represents the FileMode of the file.\"\n type: \"integer\"\n format: \"uint32\"\n Runtime:\n description: |\n Runtime represents a target that is not mounted into the\n container but is used by the task\n\n
\n\n > **Note**: `Configs.File` and `Configs.Runtime` are mutually\n > exclusive\n type: \"object\"\n ConfigID:\n description: |\n ConfigID represents the ID of the specific config that we're\n referencing.\n type: \"string\"\n ConfigName:\n description: |\n ConfigName is the name of the config that this references,\n but this is just provided for lookup/display purposes. The\n config in the reference will be identified by its ID.\n type: \"string\"\n Isolation:\n type: \"string\"\n description: |\n Isolation technology of the containers running the service.\n (Windows only)\n enum:\n - \"default\"\n - \"process\"\n - \"hyperv\"\n Init:\n description: |\n Run an init inside the container that forwards signals and reaps\n processes. This field is omitted if empty, and the default (as\n configured on the daemon) is used.\n type: \"boolean\"\n x-nullable: true\n Sysctls:\n description: |\n Set kernel namedspaced parameters (sysctls) in the container.\n The Sysctls option on services accepts the same sysctls as the\n are supported on containers. Note that while the same sysctls are\n supported, no guarantees or checks are made about their\n suitability for a clustered environment, and it's up to the user\n to determine whether a given sysctl will work properly in a\n Service.\n type: \"object\"\n additionalProperties:\n type: \"string\"\n # This option is not used by Windows containers\n CapabilityAdd:\n type: \"array\"\n description: |\n A list of kernel capabilities to add to the default set\n for the container.\n items:\n type: \"string\"\n example:\n - \"CAP_NET_RAW\"\n - \"CAP_SYS_ADMIN\"\n - \"CAP_SYS_CHROOT\"\n - \"CAP_SYSLOG\"\n CapabilityDrop:\n type: \"array\"\n description: |\n A list of kernel capabilities to drop from the default set\n for the container.\n items:\n type: \"string\"\n example:\n - \"CAP_NET_RAW\"\n Ulimits:\n description: |\n A list of resource limits to set in the container. For example: `{\"Name\": \"nofile\", \"Soft\": 1024, \"Hard\": 2048}`\"\n type: \"array\"\n items:\n type: \"object\"\n properties:\n Name:\n description: \"Name of ulimit\"\n type: \"string\"\n Soft:\n description: \"Soft limit\"\n type: \"integer\"\n Hard:\n description: \"Hard limit\"\n type: \"integer\"\n NetworkAttachmentSpec:\n description: |\n Read-only spec type for non-swarm containers attached to swarm overlay\n networks.\n\n