centersl/docker-docs
1
0
Fork 0
mirror of https://github.com/docker/docs.git synced 2026-03-28 14:58:53 +07:00
Code Issues Packages Projects Releases Wiki Activity
Files
ef887fdca3c7c5217009f1dab6ca662e0417d320
docker-docs/engine/reference/api/docker_remote_api/index.html
Misty Stanley-Jones aa4d8f90e3 V 1.11 js archives (#2308) 
* Add an admonition to the top of the archive

    Only works if you are online and the JSON file is available at
    https://docs.docker.com/js/archives.json

    * Fix JS errors, add Segment, hide old archive links
2017-03-14 11:01:36 -07:00

3387 lines
147 KiB
HTML
Raw Blame History

<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<meta name="description" content="API Documentation for Docker">
<meta name="keywords" content="[API, Docker, rcli, REST, documentation]">
<title>Remote API </title>
<link rel="shortcut icon" href="../../../../images/favicon.png" type="image/png">
<link rel="stylesheet" href="/dist/assets/css/bootstrap-custom.css"/>
<link rel="stylesheet" href="/dist/assets/css/app.css" />
<link rel="stylesheet" href="//cdnjs.cloudflare.com/ajax/libs/animate.css/3.2.6/animate.min.css">
<link rel="stylesheet" href="../../../../css/custom.css">
<script src="https://ajax.googleapis.com/ajax/libs/jquery/1.11.3/jquery.min.js"></script>
<script src="/dist/assets/js/bootstrap-3.0.3.min.js"></script>
<script src="../../../../dist/assets/js/modernizr.js"></script>
</head>
<body>
<div class="off-canvas-wrap" data-offcanvas>
<div class="inner-wrap">
<a class="left-off-canvas-toggle" href="#" >
<svg version="1.1" id="Layer_1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" x="0px" y="0px" width="35px" height="35px" viewBox="0 0 35 35" enable-background="new 0 0 35 35" xml:space="preserve">
<path fill="#3597D4" d="M30.583,9.328c0,0.752-0.539,1.362-1.203,1.362H5.113c-0.664,0-1.203-0.61-1.203-1.362l0,0
c0-0.752,0.539-1.362,1.203-1.362H29.38C30.045,7.966,30.583,8.576,30.583,9.328L30.583,9.328z"/>
<path fill="#3597D4" d="M30.583,17.09c0,0.752-0.539,1.362-1.203,1.362H5.113c-0.664,0-1.203-0.61-1.203-1.362l0,0
c0-0.752,0.539-1.362,1.203-1.362H29.38C30.045,15.728,30.583,16.338,30.583,17.09L30.583,17.09z"/>
<path fill="#3597D4" d="M30.583,24.387c0,0.752-0.539,1.362-1.203,1.362H5.113c-0.664,0-1.203-0.61-1.203-1.362l0,0
c0-0.752,0.539-1.362,1.203-1.362H29.38C30.045,23.025,30.583,23.635,30.583,24.387L30.583,24.387z"/>
</svg>
</a>
<a class="button secondary small get-started-cta">Get Started</a>
<header class="main-header">
<div class="row">
<div class="large-3 columns">
<a href="https://www.docker.com/"><img class="logo" src="../../../../dist/assets/images/logo.png"></a>
</div>
<div class="large-9 columns">
<ul class="nav-global">
<li><a href="https://www.docker.com/docker-support-services">Support</a></li>
<li><a href="https://training.docker.com/">Training</a></li>
<li><a href="https://docs.docker.com/">Docs</a></li>
<li><a href="http://blog.docker.com/">Blog</a></li>
<li><a href="https://hub.docker.com/">Docker Hub</a></li>
<li><a class="button" href="../../../../mac/started/">Get Started</a></li>
</ul>
<ul class="nav-main">
<li><a href="https://www.docker.com/products/overview">Products</a>
<ul>
<li><a href="https://www.docker.com/pricing">Pricing</a></li>
<li><a href="https://www.docker.com/what-docker">What is Docker?</a></li>
</ul>
</li>
<li><a href="https://www.docker.com/customers">Customers</a></li>
<li><a href="https://www.docker.com/docker-community">Community</a>
<ul>
<li><a href="https://www.docker.com/community/meetup-groups">Meetups</a></li>
<li><a href="https://www.docker.com/community/events">Events</a></li>
<li><a href="https://forums.docker.com">Forums</a></li>
<li><a href="http://www.scoop.it/t/docker-by-docker">Community News</a></li>
</ul>
</li>
<li><a href="https://www.docker.com/find-partner">Partners</a>
<ul>
<li><a href="https://www.docker.com/partners/partner-program">Partner Program</a></li>
</ul>
</li>
<li><a href="https://www.docker.com/company">Company</a>
<ul>
<li><a href="https://www.docker.com/company/news-and-press">News &amp; Press</a></li>
<li><a href="https://www.docker.com/careers">Work at Docker</a></li>
<li><a href="https://www.docker.com/company/management">Management</a></li>
<li><a href="https://www.docker.com/company/contact">Contact</a></li>
</ul>
</li>
<li><a href="https://www.docker.com/open-source">Open Source</a>
<ul>
<li><a href="https://www.docker.com/contribute">Contribute</a></li>
</ul>
</li>
</ul>
</div>
</div>
</header>
<aside class="left-off-canvas-menu">
<ul class="off-canvas-list">
<li class="has-submenu"><a href="#">Products</a>
<ul class="left-submenu">
<li class="back"><a href="#">Back</a></li>
<li><a href="#">Pricing</a></li>
<li><a href="#">What Is Docker</a></li>
<li><a href="#">Products</a></li>
<li><a href="#">Docker Engine</a></li>
<li><a href="#">Docker Hub</a></li>
<li><a href="#">Docker Registry</a></li>
<li><a href="#">Docker Machine</a></li>
<li><a href="#">Docker Swarm</a></li>
<li><a href="#">Docker Compose</a></li>
<li><a href="#">Kitematic</a></li>
</ul>
</li>
<li><a href="#">Customers</a></li>
<li class="has-submenu"><a href="#">Community</a>
<ul class="left-submenu">
<li class="back"><a href="#">Back</a></li>
<li><a href="#">Community</a></li>
<li><a href="#">Meetups</a></li>
<li><a href="https://www.docker.com/community/events">Events</a></li>
<li><a href="#">Forum</a></li>
<li><a href="#">Scoop.it</a></li>
</ul>
</li>
<li class="has-submenu"><a href="#">Partners</a>
<ul class="left-submenu">
<li class="back"><a href="#">Back</a></li>
<li><a href="#">Partners</a></li>
<li><a href="https://www.docker.com/partners/partner-program">Partners Program</a></li>
</ul>
</li>
<li><a href="#">Company</a></li>
<li class="has-submenu"><a href="#">Open Source</a>
<ul class="left-submenu">
<li class="back"><a href="#">Back</a></li>
<li><a href="#">Open Source</a></li>
<li><a href="#">Contribute</a></li>
<li><a href="#">Governance</a></li>
</ul>
</li>
</ul>
<ul class="nav-global-off-canvas">
<li><a href="#">Support</a></li>
<li><a href="#">Training</a></li>
<li><a href="#">Docs</a></li>
<li><a href="#">Blog</a></li>
<li><a href="#">Sign in</a></li>
<li><a href="#">Sign up</a></li>
</ul>
</aside>
<a class="exit-off-canvas"></a>
<div id="docs" class="row">
<div class="large-3 columns">
<section id="multiple" data-accordion-group>
<section data-accordion>
<article data-accordion>
<button data-control> Docker Engine</button>
<div data-content>
<a data-link href="../../../../engine/quickstart/" class=""> Quickstart</a>
<a data-link href="../../../../engine/understanding-docker/" class=""> Understand the architecture</a>
<article data-accordion>
<button data-control> Install</button>
<div data-content>
<a data-link href="../../../../engine/installation/mac/" class=""> Installation on Mac OS X</a>
<a data-link href="../../../../engine/installation/windows/" class=""> Installation on Windows</a>
<article data-accordion>
<button data-control> On Linux distributions</button>
<div data-content>
<a data-link href="../../../../engine/installation/linux/ubuntulinux/" class=""> Installation on Ubuntu </a>
<a data-link href="../../../../engine/installation/linux/rhel/" class=""> Installation on Red Hat Enterprise Linux</a>
<a data-link href="../../../../engine/installation/linux/centos/" class=""> Installation on CentOS</a>
<a data-link href="../../../../engine/installation/linux/fedora/" class=""> Installation on Fedora</a>
<a data-link href="../../../../engine/installation/linux/debian/" class=""> Installation on Debian</a>
<a data-link href="../../../../engine/installation/linux/archlinux/" class=""> Installation on Arch Linux</a>
<a data-link href="../../../../engine/installation/linux/cruxlinux/" class=""> Installation on CRUX Linux</a>
<a data-link href="../../../../engine/installation/linux/frugalware/" class=""> Installation on FrugalWare</a>
<a data-link href="../../../../engine/installation/linux/gentoolinux/" class=""> Installation on Gentoo</a>
<a data-link href="../../../../engine/installation/linux/oracle/" class=""> Installation on Oracle Linux</a>
<a data-link href="../../../../engine/installation/linux/SUSE/" class=""> Installation on openSUSE and SUSE Linux Enterprise</a>
</div>
</article>
<article data-accordion>
<button data-control> On cloud providers</button>
<div data-content>
<a data-link href="../../../../engine/installation/cloud/overview/" class=""> Choose how to install</a>
<a data-link href="../../../../engine/installation/cloud/cloud-ex-aws/" class=""> Example: Manual install on cloud provider</a>
<a data-link href="../../../../engine/installation/cloud/cloud-ex-machine-ocean/" class=""> Example: Use Docker Machine to provision cloud hosts</a>
</div>
</article>
<a data-link href="../../../../engine/installation/binaries/" class=""> Installation from binaries</a>
</div>
</article>
<article data-accordion>
<button data-control> User guide</button>
<div data-content>
<a data-link href="../../../../engine/userguide/intro/" class=""> Introduction</a>
<article data-accordion>
<button data-control> Learn by example</button>
<div data-content>
<a data-link href="../../../../engine/userguide/containers/dockerizing/" class=""> Hello world in a container</a>
<a data-link href="../../../../engine/userguide/containers/usingdocker/" class=""> Run a simple application</a>
<a data-link href="../../../../engine/userguide/containers/dockerimages/" class=""> Build your own images</a>
<a data-link href="../../../../engine/userguide/containers/networkingcontainers/" class=""> Network containers</a>
<a data-link href="../../../../engine/userguide/containers/dockervolumes/" class=""> Manage data in containers</a>
<a data-link href="../../../../engine/userguide/containers/dockerrepos/" class=""> Store images on Docker Hub</a>
</div>
</article>
<article data-accordion>
<button data-control> Work with images</button>
<div data-content>
<a data-link href="../../../../engine/userguide/eng-image/dockerfile_best-practices/" class=""> Best practices for writing Dockerfiles</a>
<a data-link href="../../../../engine/userguide/eng-image/baseimages/" class=""> Create a base image</a>
<a data-link href="../../../../engine/userguide/eng-image/image_management/" class=""> Image management</a>
</div>
</article>
<article data-accordion>
<button data-control> Docker storage drivers</button>
<div data-content>
<a data-link href="../../../../engine/userguide/storagedriver/imagesandcontainers/" class=""> Understand images, containers, and storage drivers</a>
<a data-link href="../../../../engine/userguide/storagedriver/selectadriver/" class=""> Select a storage driver</a>
<a data-link href="../../../../engine/userguide/storagedriver/aufs-driver/" class=""> AUFS storage driver in practice</a>
<a data-link href="../../../../engine/userguide/storagedriver/btrfs-driver/" class=""> Btrfs storage in practice</a>
<a data-link href="../../../../engine/userguide/storagedriver/device-mapper-driver/" class=""> Device mapper storage in practice</a>
<a data-link href="../../../../engine/userguide/storagedriver/overlayfs-driver/" class=""> OverlayFS storage in practice</a>
<a data-link href="../../../../engine/userguide/storagedriver/zfs-driver/" class=""> ZFS storage in practice</a>
</div>
</article>
<article data-accordion>
<button data-control> Network configuration</button>
<div data-content>
<a data-link href="../../../../engine/userguide/networking/dockernetworks/" class=""> Docker container networking</a>
<a data-link href="../../../../engine/userguide/networking/work-with-networks/" class=""> Work with network commands</a>
<a data-link href="../../../../engine/userguide/networking/get-started-overlay/" class=""> Get started with multi-host networking</a>
<a data-link href="../../../../engine/userguide/networking/configure-dns/" class=""> Configure container DNS in user-defined networks</a>
<a data-link href="../../../../engine/userguide/networking/default_network/" class=""> Default bridge network</a>
</div>
</article>
<a data-link href="../../../../engine/userguide/labels-custom-metadata/" class=""> Apply custom metadata</a>
</div>
</article>
<article data-accordion>
<button data-control> Administrate</button>
<div data-content>
<a data-link href="../../../../engine/admin/formatting/" class=""> Format command and log output</a>
<a data-link href="../../../../engine/admin/host_integration/" class=""> Automatically start containers</a>
<a data-link href="../../../../engine/admin/systemd/" class=""> Control and configure Docker with systemd</a>
<a data-link href="../../../../engine/admin/dsc/" class=""> PowerShell DSC Usage</a>
<a data-link href="../../../../engine/admin/chef/" class=""> Using Chef</a>
<a data-link href="../../../../engine/admin/puppet/" class=""> Using Puppet</a>
<a data-link href="../../../../engine/admin/using_supervisord/" class=""> Using Supervisor with Docker</a>
<a data-link href="../../../../engine/admin/configuring/" class=""> Configuring and running Docker</a>
<a data-link href="../../../../engine/admin/runmetrics/" class=""> Runtime metrics</a>
<a data-link href="../../../../engine/admin/ambassador_pattern_linking/" class=""> Link via an ambassador container</a>
<article data-accordion>
<button data-control> Logging</button>
<div data-content>
<a data-link href="../../../../engine/admin/logging/overview/" class=""> Configuring Logging Drivers</a>
<a data-link href="../../../../engine/admin/logging/log_tags/" class=""> Log tags for logging driver</a>
<a data-link href="../../../../engine/admin/logging/awslogs/" class=""> Amazon CloudWatch Logs logging driver</a>
<a data-link href="../../../../engine/admin/logging/etwlogs/" class=""> ETW logging driver</a>
<a data-link href="../../../../engine/admin/logging/fluentd/" class=""> Fluentd logging driver</a>
<a data-link href="../../../../engine/admin/logging/gcplogs/" class=""> Google Cloud Logging driver</a>
<a data-link href="../../../../engine/admin/logging/journald/" class=""> Journald logging driver</a>
<a data-link href="../../../../engine/admin/logging/splunk/" class=""> Splunk logging driver</a>
</div>
</article>
<a data-link href="../../../../engine/admin/registry_mirror/" class=""> Run a local registry mirror</a>
</div>
</article>
<article data-accordion>
<button data-control> Secure Engine</button>
<div data-content>
<a data-link href="../../../../engine/security/security/" class=""> Docker security</a>
<a data-link href="../../../../engine/security/non-events/" class=""> Docker Security Non-events</a>
<a data-link href="../../../../engine/security/https/" class=""> Protect the Docker daemon socket</a>
<a data-link href="../../../../engine/security/certificates/" class=""> Using certificates for repository client verification</a>
<article data-accordion>
<button data-control> Use trusted images</button>
<div data-content>
<a data-link href="../../../../engine/security/trust/content_trust/" class=""> Content trust in Docker</a>
<a data-link href="../../../../engine/security/trust/trust_automation/" class=""> Automation with content trust</a>
<a data-link href="../../../../engine/security/trust/trust_delegation/" class=""> Delegations for content trust</a>
<a data-link href="../../../../engine/security/trust/deploying_notary/" class=""> Deploying Notary</a>
<a data-link href="../../../../engine/security/trust/trust_key_mng/" class=""> Manage keys for content trust</a>
<a data-link href="../../../../engine/security/trust/trust_sandbox/" class=""> Play in a content trust sandbox</a>
</div>
</article>
<a data-link href="../../../../engine/security/apparmor/" class=""> AppArmor security profiles for Docker</a>
<a data-link href="../../../../engine/security/seccomp/" class=""> Seccomp security profiles for Docker</a>
</div>
</article>
<article data-accordion>
<button data-control> Extend Engine</button>
<div data-content>
<a data-link href="../../../../engine/extend/plugins_authorization/" class=""> Access authorization plugin</a>
<a data-link href="../../../../engine/extend/plugins/" class=""> Extending Engine with plugins</a>
<a data-link href="../../../../engine/extend/plugins_network/" class=""> Docker network driver plugins</a>
<a data-link href="../../../../engine/extend/plugins_volume/" class=""> Volume plugins</a>
<a data-link href="../../../../engine/extend/plugin_api/" class=""> Plugins API</a>
</div>
</article>
<article data-accordion>
<button data-control> Dockerize an application</button>
<div data-content>
<a data-link href="../../../../engine/examples/mongodb/" class=""> Dockerizing MongoDB</a>
<a data-link href="../../../../engine/examples/postgresql_service/" class=""> Dockerizing PostgreSQL</a>
<a data-link href="../../../../engine/examples/couchdb_data_volumes/" class=""> Dockerizing a CouchDB service</a>
<a data-link href="../../../../engine/examples/couchbase/" class=""> Dockerizing a Couchbase service</a>
<a data-link href="../../../../engine/examples/running_redis_service/" class=""> Dockerizing a Redis service</a>
<a data-link href="../../../../engine/examples/running_riak_service/" class=""> Dockerizing a Riak service</a>
<a data-link href="../../../../engine/examples/running_ssh_service/" class=""> Dockerizing an SSH service</a>
<a data-link href="../../../../engine/examples/apt-cacher-ng/" class=""> Dockerizing an apt-cacher-ng service</a>
</div>
</article>
<article data-accordion>
<button data-control> Engine reference</button>
<div data-content>
<a data-link href="../../../../engine/reference/builder/" class=""> Dockerfile reference</a>
<a data-link href="../../../../engine/reference/run/" class=""> Docker run reference</a>
<article data-accordion>
<button data-control> Command line reference</button>
<div data-content>
<a data-link href="../../../../engine/reference/commandline/cli/" class=""> Use the Docker command line</a>
<a data-link href="../../../../engine/reference/commandline/daemon/" class=""> daemon</a>
<a data-link href="../../../../engine/reference/commandline/attach/" class=""> attach</a>
<a data-link href="../../../../engine/reference/commandline/build/" class=""> build</a>
<a data-link href="../../../../engine/reference/commandline/commit/" class=""> commit</a>
<a data-link href="../../../../engine/reference/commandline/cp/" class=""> cp</a>
<a data-link href="../../../../engine/reference/commandline/create/" class=""> create</a>
<a data-link href="../../../../engine/reference/commandline/diff/" class=""> diff</a>
<a data-link href="../../../../engine/reference/commandline/events/" class=""> events</a>
<a data-link href="../../../../engine/reference/commandline/exec/" class=""> exec</a>
<a data-link href="../../../../engine/reference/commandline/export/" class=""> export</a>
<a data-link href="../../../../engine/reference/commandline/history/" class=""> history</a>
<a data-link href="../../../../engine/reference/commandline/images/" class=""> images</a>
<a data-link href="../../../../engine/reference/commandline/import/" class=""> import</a>
<a data-link href="../../../../engine/reference/commandline/info/" class=""> info</a>
<a data-link href="../../../../engine/reference/commandline/inspect/" class=""> inspect</a>
<a data-link href="../../../../engine/reference/commandline/kill/" class=""> kill</a>
<a data-link href="../../../../engine/reference/commandline/load/" class=""> load</a>
<a data-link href="../../../../engine/reference/commandline/login/" class=""> login</a>
<a data-link href="../../../../engine/reference/commandline/logout/" class=""> logout</a>
<a data-link href="../../../../engine/reference/commandline/logs/" class=""> logs</a>
<a data-link href="../../../../engine/reference/commandline/network_connect/" class=""> network connect</a>
<a data-link href="../../../../engine/reference/commandline/network_create/" class=""> network create</a>
<a data-link href="../../../../engine/reference/commandline/network_disconnect/" class=""> network disconnect</a>
<a data-link href="../../../../engine/reference/commandline/network_inspect/" class=""> network inspect</a>
<a data-link href="../../../../engine/reference/commandline/network_ls/" class=""> network ls</a>
<a data-link href="../../../../engine/reference/commandline/network_rm/" class=""> network rm</a>
<a data-link href="../../../../engine/reference/commandline/pause/" class=""> pause</a>
<a data-link href="../../../../engine/reference/commandline/port/" class=""> port</a>
<a data-link href="../../../../engine/reference/commandline/ps/" class=""> ps</a>
<a data-link href="../../../../engine/reference/commandline/pull/" class=""> pull</a>
<a data-link href="../../../../engine/reference/commandline/push/" class=""> push</a>
<a data-link href="../../../../engine/reference/commandline/rename/" class=""> rename</a>
<a data-link href="../../../../engine/reference/commandline/restart/" class=""> restart</a>
<a data-link href="../../../../engine/reference/commandline/rm/" class=""> rm</a>
<a data-link href="../../../../engine/reference/commandline/rmi/" class=""> rmi</a>
<a data-link href="../../../../engine/reference/commandline/run/" class=""> run</a>
<a data-link href="../../../../engine/reference/commandline/save/" class=""> save</a>
<a data-link href="../../../../engine/reference/commandline/search/" class=""> search</a>
<a data-link href="../../../../engine/reference/commandline/start/" class=""> start</a>
<a data-link href="../../../../engine/reference/commandline/stats/" class=""> stats</a>
<a data-link href="../../../../engine/reference/commandline/stop/" class=""> stop</a>
<a data-link href="../../../../engine/reference/commandline/tag/" class=""> tag</a>
<a data-link href="../../../../engine/reference/commandline/top/" class=""> top</a>
<a data-link href="../../../../engine/reference/commandline/unpause/" class=""> unpause</a>
<a data-link href="../../../../engine/reference/commandline/update/" class=""> update</a>
<a data-link href="../../../../engine/reference/commandline/version/" class=""> version</a>
<a data-link href="../../../../engine/reference/commandline/volume_create/" class=""> volume create</a>
<a data-link href="../../../../engine/reference/commandline/volume_inspect/" class=""> volume inspect</a>
<a data-link href="../../../../engine/reference/commandline/volume_ls/" class=""> volume ls</a>
<a data-link href="../../../../engine/reference/commandline/volume_rm/" class=""> volume rm</a>
<a data-link href="../../../../engine/reference/commandline/wait/" class=""> wait</a>
</div>
</article>
<article data-accordion>
<button data-control> API Reference</button>
<div data-content>
<a data-link href="../../../../engine/reference/api/docker_remote_api/" class=" active"> Remote API</a>
<a data-link href="../../../../engine/reference/api/docker_remote_api_v1.23/" class=""> Remote API v1.23</a>
<a data-link href="../../../../engine/reference/api/docker_remote_api_v1.22/" class=""> Remote API v1.22</a>
<a data-link href="../../../../engine/reference/api/docker_remote_api_v1.21/" class=""> Remote API v1.21</a>
<a data-link href="../../../../engine/reference/api/docker_remote_api_v1.20/" class=""> Remote API v1.20</a>
<a data-link href="../../../../engine/reference/api/docker_remote_api_v1.19/" class=""> Remote API v1.19</a>
<a data-link href="../../../../engine/reference/api/docker_remote_api_v1.18/" class=""> Remote API v1.18</a>
<a data-link href="../../../../engine/reference/api/remote_api_client_libraries/" class=""> Remote API client libraries</a>
<a data-link href="../../../../engine/reference/api/docker_io_accounts_api/" class=""> docker.io accounts API</a>
</div>
</article>
</div>
</article>
<a data-link href="../../../../engine/migration/" class=""> Migrate to Engine 1.10</a>
<a data-link href="../../../../engine/breaking_changes/" class=""> Breaking changes</a>
<a data-link href="../../../../engine/deprecated/" class=""> Deprecated Engine Features</a>
<a data-link href="../../../../engine/faq/" class=""> FAQ</a>
</div>
</article>
</section>
<section data-accordion>
<article data-accordion>
<button data-control> Docker Swarm</button>
<div data-content>
<a data-link href="../../../../swarm/overview/" class=""> Swarm Overview</a>
<a data-link href="../../../../swarm/get-swarm/" class=""> How to get Swarm</a>
<a data-link href="../../../../swarm/install-w-machine/" class=""> Evaluate Swarm in a sandbox</a>
<a data-link href="../../../../swarm/plan-for-production/" class=""> Plan for Swarm in production</a>
<a data-link href="../../../../swarm/install-manual/" class=""> Build a Swarm cluster for production</a>
<article data-accordion>
<button data-control> Try Swarm at scale</button>
<div data-content>
<a data-link href="../../../../swarm/swarm_at_scale/about/" class=""> Learn the application architecture</a>
<a data-link href="../../../../swarm/swarm_at_scale/deploy-infra/" class=""> Deploy application infrastructure</a>
<a data-link href="../../../../swarm/swarm_at_scale/deploy-app/" class=""> Deploy the application</a>
<a data-link href="../../../../swarm/swarm_at_scale/troubleshoot/" class=""> Troubleshoot the application</a>
</div>
</article>
<a data-link href="../../../../swarm/multi-manager-setup/" class=""> High availability in Swarm</a>
<a data-link href="../../../../swarm/networking/" class=""> Swarm and container networks</a>
<a data-link href="../../../../swarm/discovery/" class=""> Discovery</a>
<a data-link href="../../../../swarm/provision-with-machine/" class=""> Provision with Machine</a>
<article data-accordion>
<button data-control> Scheduling</button>
<div data-content>
<a data-link href="../../../../swarm/scheduler/filter/" class=""> Filters</a>
<a data-link href="../../../../swarm/scheduler/rescheduling/" class=""> Rescheduling</a>
<a data-link href="../../../../swarm/scheduler/strategy/" class=""> Strategies</a>
</div>
</article>
<a data-link href="../../../../swarm/secure-swarm-tls/" class=""> Overview Docker Swarm with TLS</a>
<a data-link href="../../../../swarm/configure-tls/" class=""> Configure Docker Swarm for TLS</a>
<article data-accordion>
<button data-control> Command line reference</button>
<div data-content>
<a data-link href="../../../../swarm/reference/create/" class=""> create</a>
<a data-link href="../../../../swarm/reference/help/" class=""> help</a>
<a data-link href="../../../../swarm/reference/join/" class=""> join</a>
<a data-link href="../../../../swarm/reference/list/" class=""> list</a>
<a data-link href="../../../../swarm/reference/manage/" class=""> manage</a>
<a data-link href="../../../../swarm/reference/swarm/" class=""> swarm</a>
</div>
</article>
<a data-link href="../../../../swarm/status-code-comparison-to-docker/" class=""> API response codes</a>
<a data-link href="../../../../swarm/swarm-api/" class=""> Docker Swarm API</a>
</div>
</article>
</section>
<section data-accordion>
<article data-accordion>
<button data-control> Docker Compose</button>
<div data-content>
<a data-link href="../../../../compose/overview/" class=""> Overview of Docker Compose</a>
<a data-link href="../../../../compose/install/" class=""> Install Compose</a>
<a data-link href="../../../../compose/gettingstarted/" class=""> Getting Started</a>
<a data-link href="../../../../compose/swarm/" class=""> Using Compose with Swarm</a>
<a data-link href="../../../../compose/django/" class=""> Quickstart: Compose and Django</a>
<a data-link href="../../../../compose/rails/" class=""> Quickstart: Compose and Rails</a>
<a data-link href="../../../../compose/wordpress/" class=""> Quickstart: Compose and WordPress</a>
<a data-link href="../../../../compose/env-file/" class=""> Environment file</a>
<a data-link href="../../../../compose/extends/" class=""> Extending Services in Compose</a>
<a data-link href="../../../../compose/networking/" class=""> Networking in Compose</a>
<a data-link href="../../../../compose/production/" class=""> Using Compose in Production</a>
<a data-link href="../../../../compose/compose-file/" class=""> Compose File Reference</a>
<article data-accordion>
<button data-control> Command-line Reference</button>
<div data-content>
<a data-link href="../../../../compose/reference/overview/" class=""> Overview of docker-compose CLI</a>
<a data-link href="../../../../compose/reference/envvars/" class=""> CLI Environment Variables</a>
<a data-link href="../../../../compose/reference/build/" class=""> build</a>
<a data-link href="../../../../compose/reference/config/" class=""> config</a>
<a data-link href="../../../../compose/reference/create/" class=""> create</a>
<a data-link href="../../../../compose/reference/down/" class=""> down</a>
<a data-link href="../../../../compose/reference/events/" class=""> events</a>
<a data-link href="../../../../compose/reference/exec/" class=""> exec</a>
<a data-link href="../../../../compose/reference/help/" class=""> help</a>
<a data-link href="../../../../compose/reference/kill/" class=""> kill</a>
<a data-link href="../../../../compose/reference/logs/" class=""> logs</a>
<a data-link href="../../../../compose/reference/pause/" class=""> pause</a>
<a data-link href="../../../../compose/reference/port/" class=""> port</a>
<a data-link href="../../../../compose/reference/ps/" class=""> ps</a>
<a data-link href="../../../../compose/reference/pull/" class=""> pull</a>
<a data-link href="../../../../compose/reference/restart/" class=""> restart</a>
<a data-link href="../../../../compose/reference/rm/" class=""> rm</a>
<a data-link href="../../../../compose/reference/run/" class=""> run</a>
<a data-link href="../../../../compose/reference/scale/" class=""> scale</a>
<a data-link href="../../../../compose/reference/start/" class=""> start</a>
<a data-link href="../../../../compose/reference/stop/" class=""> stop</a>
<a data-link href="../../../../compose/reference/unpause/" class=""> unpause</a>
<a data-link href="../../../../compose/reference/up/" class=""> up</a>
</div>
</article>
<a data-link href="../../../../compose/completion/" class=""> Command-line Completion</a>
<a data-link href="../../../../compose/link-env-deprecated/" class=""> Link Environment Variables</a>
<a data-link href="../../../../compose/startup-order/" class=""> Controlling startup order</a>
<a data-link href="../../../../compose/faq/" class=""> Frequently Asked Questions</a>
</div>
</article>
</section>
<section data-accordion>
<article data-accordion>
<button data-control> Docker Hub</button>
<div data-content>
<a data-link href="../../../../docker-hub/overview/" class=""> Introducing Docker Hub</a>
<a data-link href="../../../../docker-hub/accounts/" class=""> Your Docker ID</a>
<a data-link href="../../../../docker-hub/orgs/" class=""> Teams &amp; Organizations</a>
<a data-link href="../../../../docker-hub/repos/" class=""> Repositories on Docker Hub</a>
<a data-link href="../../../../docker-hub/builds/" class=""> Automated Builds</a>
<a data-link href="../../../../docker-hub/webhooks/" class=""> Webhooks for automated builds</a>
<a data-link href="../../../../docker-hub/bitbucket/" class=""> Automated Builds with Bitbucket</a>
<a data-link href="../../../../docker-hub/github/" class=""> Automated Builds from GitHub</a>
<a data-link href="../../../../docker-hub/official_repos/" class=""> Official Repositories on Docker Hub</a>
</div>
</article>
</section>
<section data-accordion>
<article data-accordion>
<button data-control> CS Docker Engine</button>
<div data-content>
<a data-link href="../../../../docker-trusted-registry/cs-engine/install/" class=""> Install CS Docker Engine</a>
<a data-link href="../../../../docker-trusted-registry/cs-engine/upgrade/" class=""> Upgrade</a>
<article data-accordion>
<button data-control> Release notes</button>
<div data-content>
<a data-link href="../../../../docker-trusted-registry/cs-engine/release-notes/release-notes/" class=""> CS Engine release notes</a>
<a data-link href="../../../../docker-trusted-registry/cs-engine/release-notes/prior-release-notes/" class=""> Prior CS Engine release notes</a>
</div>
</article>
</div>
</article>
</section>
<section data-accordion>
<article data-accordion>
<button data-control> Universal Control Plane</button>
<div data-content>
<a data-link href="../../../../ucp/overview/" class=""> Universal Control Plane overview</a>
<a data-link href="../../../../ucp/install-sandbox/" class=""> Evaluate UCP in a sandbox</a>
<a data-link href="../../../../ucp/architecture/" class=""> Architecture</a>
<article data-accordion>
<button data-control> Installation</button>
<div data-content>
<a data-link href="../../../../ucp/installation/system-requirements/" class=""> System requirements</a>
<a data-link href="../../../../ucp/installation/plan-production-install/" class=""> Plan a production installation</a>
<a data-link href="../../../../ucp/installation/install-production/" class=""> Install UCP for production</a>
<a data-link href="../../../../ucp/installation/install-offline/" class=""> Install offline</a>
<a data-link href="../../../../ucp/installation/license/" class=""> License UCP</a>
<a data-link href="../../../../ucp/installation/upgrade/" class=""> Upgrade UCP</a>
<a data-link href="../../../../ucp/installation/uninstall/" class=""> Uninstall UCP</a>
<article data-accordion>
<button data-control> UCP tool reference</button>
<div data-content>
<a data-link href="../../../../ucp/reference/backup/" class=""> backup</a>
<a data-link href="../../../../ucp/reference/dump-certs/" class=""> dump-certs</a>
<a data-link href="../../../../ucp/reference/engine-discovery/" class=""> engine-discovery</a>
<a data-link href="../../../../ucp/reference/fingerprint/" class=""> fingerprint</a>
<a data-link href="../../../../ucp/reference/help/" class=""> help</a>
<a data-link href="../../../../ucp/reference/id/" class=""> id</a>
<a data-link href="../../../../ucp/reference/images/" class=""> images</a>
<a data-link href="../../../../ucp/reference/install/" class=""> install</a>
<a data-link href="../../../../ucp/reference/join/" class=""> join</a>
<a data-link href="../../../../ucp/reference/regen-certs/" class=""> regen-certs.md</a>
<a data-link href="../../../../ucp/reference/restart/" class=""> restart</a>
<a data-link href="../../../../ucp/reference/restore/" class=""> restore</a>
<a data-link href="../../../../ucp/reference/stop/" class=""> stop</a>
<a data-link href="../../../../ucp/reference/uninstall/" class=""> uninstall</a>
<a data-link href="../../../../ucp/reference/upgrade/" class=""> upgrade</a>
</div>
</article>
</div>
</article>
<article data-accordion>
<button data-control> Access UCP</button>
<div data-content>
<a data-link href="../../../../ucp/access-ucp/web-based-access/" class=""> Web-based access</a>
<a data-link href="../../../../ucp/access-ucp/cli-based-access/" class=""> CLI-based access</a>
</div>
</article>
<article data-accordion>
<button data-control> Configuration</button>
<div data-content>
<a data-link href="../../../../ucp/configuration/multi-host-networking/" class=""> Set up container networking</a>
<a data-link href="../../../../ucp/configuration/dtr-integration/" class=""> Integrate with Docker Trusted Registry</a>
<a data-link href="../../../../ucp/configuration/configure-logs/" class=""> Configure UCP logging</a>
</div>
</article>
<article data-accordion>
<button data-control> Monitor and troubleshoot</button>
<div data-content>
<a data-link href="../../../../ucp/monitor/monitor-ucp/" class=""> Monitor your cluster</a>
<a data-link href="../../../../ucp/monitor/troubleshoot-ucp/" class=""> Troubleshoot your cluster</a>
<a data-link href="../../../../ucp/monitor/troubleshoot-configurations/" class=""> Troubleshoot cluster configurations</a>
</div>
</article>
<article data-accordion>
<button data-control> High-availability</button>
<div data-content>
<a data-link href="../../../../ucp/high-availability/set-up-high-availability/" class=""> Set up high availability</a>
<a data-link href="../../../../ucp/high-availability/replicate-cas/" class=""> Replicate CAs for high availability</a>
<a data-link href="../../../../ucp/high-availability/backups-and-disaster-recovery/" class=""> Backups and disaster recovery</a>
</div>
</article>
<article data-accordion>
<button data-control> User management</button>
<div data-content>
<a data-link href="../../../../ucp/user-management/manage-users/" class=""> Manage and authorize users</a>
</div>
</article>
<article data-accordion>
<button data-control> Applications</button>
<div data-content>
<a data-link href="../../../../ucp/applications/deploy-app-ui/" class=""> Deploy an app from the UI</a>
<a data-link href="../../../../ucp/applications/deploy-app-cli/" class=""> Deploy an app from the CLI</a>
</div>
</article>
<a data-link href="../../../../ucp/support/" class=""> Get support</a>
<a data-link href="../../../../ucp/release_notes/" class=""> Release Notes</a>
</div>
</article>
</section>
<section data-accordion>
<article data-accordion>
<button data-control> Docker Trusted Registry</button>
<div data-content>
<a data-link href="../../../../docker-trusted-registry/overview/" class=""> Docker Trusted Registry overview</a>
<a data-link href="../../../../docker-trusted-registry/quick-start/" class=""> Quickstart</a>
<a data-link href="../../../../docker-trusted-registry/architecture/" class=""> Architecture</a>
<article data-accordion>
<button data-control> Installation</button>
<div data-content>
<a data-link href="../../../../docker-trusted-registry/install/system-requirements/" class=""> System requirements</a>
<a data-link href="../../../../docker-trusted-registry/install/install-dtr/" class=""> Install Docker Trusted Registry</a>
<a data-link href="../../../../docker-trusted-registry/install/install-dtr-offline/" class=""> Install offline</a>
<a data-link href="../../../../docker-trusted-registry/install/license/" class=""> License DTR</a>
<article data-accordion>
<button data-control> Upgrade</button>
<div data-content>
<a data-link href="../../../../docker-trusted-registry/install/upgrade/upgrade-major/" class=""> Upgrade from 1.4.3</a>
<a data-link href="../../../../docker-trusted-registry/install/upgrade/upgrade-minor/" class=""> Upgrade from 2.0.0</a>
</div>
</article>
<a data-link href="../../../../docker-trusted-registry/install/uninstall/" class=""> Uninstall</a>
<article data-accordion>
<button data-control> DTR tool reference</button>
<div data-content>
<a data-link href="../../../../docker-trusted-registry/reference/backup/" class=""> backup</a>
<a data-link href="../../../../docker-trusted-registry/reference/dumpcerts/" class=""> dumpcerts</a>
<a data-link href="../../../../docker-trusted-registry/reference/install/" class=""> install</a>
<a data-link href="../../../../docker-trusted-registry/reference/join/" class=""> join</a>
<a data-link href="../../../../docker-trusted-registry/reference/migrate/" class=""> migrate</a>
<a data-link href="../../../../docker-trusted-registry/reference/reconfigure/" class=""> reconfigure</a>
<a data-link href="../../../../docker-trusted-registry/reference/remove/" class=""> remove</a>
<a data-link href="../../../../docker-trusted-registry/reference/restore/" class=""> restore</a>
</div>
</article>
</div>
</article>
<article data-accordion>
<button data-control> Configuration</button>
<div data-content>
<a data-link href="../../../../docker-trusted-registry/configure/configuration/" class=""> Configuration overview</a>
<a data-link href="../../../../docker-trusted-registry/configure/config-general/" class=""> Configure general settings</a>
<a data-link href="../../../../docker-trusted-registry/configure/config-security/" class=""> Security configuration</a>
<a data-link href="../../../../docker-trusted-registry/configure/config-storage/" class=""> Storage configuration</a>
<a data-link href="../../../../docker-trusted-registry/configure/config-auth/" class=""> Auth configuration</a>
</div>
</article>
<article data-accordion>
<button data-control> Monitor and troubleshoot</button>
<div data-content>
<a data-link href="../../../../docker-trusted-registry/monitor-troubleshoot/monitor/" class=""> Monitor DTR</a>
<a data-link href="../../../../docker-trusted-registry/monitor-troubleshoot/troubleshoot/" class=""> Troubleshoot DTR</a>
</div>
</article>
<article data-accordion>
<button data-control> High-availability</button>
<div data-content>
<a data-link href="../../../../docker-trusted-registry/high-availability/high-availability/" class=""> Set up high availability</a>
<a data-link href="../../../../docker-trusted-registry/high-availability/backups-and-disaster-recovery/" class=""> Backups and disaster recovery</a>
</div>
</article>
<article data-accordion>
<button data-control> User management</button>
<div data-content>
<a data-link href="../../../../docker-trusted-registry/user-management/permission-levels/" class=""> Permission levels</a>
</div>
</article>
<article data-accordion>
<button data-control> Repositories and images</button>
<div data-content>
<a data-link href="../../../../docker-trusted-registry/repos-and-images/create-repo/" class=""> Create a repository</a>
<a data-link href="../../../../docker-trusted-registry/repos-and-images/push-and-pull-images/" class=""> Push and pull images</a>
<a data-link href="../../../../docker-trusted-registry/repos-and-images/delete-images/" class=""> Delete images</a>
</div>
</article>
<article data-accordion>
<button data-control> DTR APIs</button>
<div data-content>
<a data-link href="../../../../apidocs/overview/" class=""> Overview</a>
<a data-link href="../../../../apidocs/v1.3.3/" class=""> v1.3.3 API</a>
<a data-link href="../../../../apidocs/v1.4.0/" class=""> v1.4.0 API</a>
<a data-link href="../../../../apidocs/v2.0.0/" class=""> v2.0.0 API</a>
<a data-link href="../../../../apidocs/v2.0.1/" class=""> v2.0.1 API</a>
</div>
</article>
<article data-accordion>
<button data-control> Release notes</button>
<div data-content>
<a data-link href="../../../../docker-trusted-registry/release-notes/release-notes/" class=""> Trusted Registry release notes</a>
<a data-link href="../../../../docker-trusted-registry/release-notes/prior-release-notes/" class=""> Prior Trusted Registry release notes</a>
</div>
</article>
<a data-link href="../../../../docker-trusted-registry/support/" class=""> Get support</a>
</div>
</article>
</section>
<section data-accordion>
<article data-accordion>
<button data-control> Docker Cloud</button>
<div data-content>
<a data-link href="../../../../docker-cloud/overview/" class=""> Docker Cloud Overview</a>
<a data-link href="../../../../docker-cloud/dockerid/" class=""> Docker ID and Settings</a>
<article data-accordion>
<button data-control> Getting Started</button>
<div data-content>
<a data-link href="../../../../docker-cloud/getting-started/intro_cloud/" class=""> Introducing Docker Cloud</a>
<a data-link href="../../../../docker-cloud/getting-started/connect-infra/" class=""> Link to your Infrastructure</a>
<a data-link href="../../../../docker-cloud/getting-started/your_first_node/" class=""> Deploy your first node</a>
<a data-link href="../../../../docker-cloud/getting-started/your_first_service/" class=""> Deploy your first service</a>
<article data-accordion>
<button data-control> Deploy an application</button>
<div data-content>
<a data-link href="../../../../docker-cloud/getting-started/deploy-app/1_introduction/" class=""> Introduction to Deploying an app in Docker Cloud</a>
<a data-link href="../../../../docker-cloud/getting-started/deploy-app/2_set_up/" class=""> Set up your environment</a>
<a data-link href="../../../../docker-cloud/getting-started/deploy-app/3_prepare_the_app/" class=""> Prepare the application</a>
<a data-link href="../../../../docker-cloud/getting-started/deploy-app/4_push_to_cloud_registry/" class=""> Push the image to Docker Cloud&#39;s Registry</a>
<a data-link href="../../../../docker-cloud/getting-started/deploy-app/5_deploy_the_app_as_a_service/" class=""> Deploy the app as a Docker Cloud service</a>
<a data-link href="../../../../docker-cloud/getting-started/deploy-app/6_define_environment_variables/" class=""> Define environment variables</a>
<a data-link href="../../../../docker-cloud/getting-started/deploy-app/7_scale_the_service/" class=""> Scale the service</a>
<a data-link href="../../../../docker-cloud/getting-started/deploy-app/8_view_logs/" class=""> View service logs</a>
<a data-link href="../../../../docker-cloud/getting-started/deploy-app/9_load-balance_the_service/" class=""> Load-balance the service</a>
<a data-link href="../../../../docker-cloud/getting-started/deploy-app/10_provision_a_data_backend_for_your_service/" class=""> Provision a data backend for the service</a>
<a data-link href="../../../../docker-cloud/getting-started/deploy-app/11_service_stacks/" class=""> Stackfiles for your service</a>
<a data-link href="../../../../docker-cloud/getting-started/deploy-app/12_data_management_with_volumes/" class=""> Data management with Volumes</a>
</div>
</article>
</div>
</article>
<article data-accordion>
<button data-control> Manage Applications</button>
<div data-content>
<a data-link href="../../../../docker-cloud/apps/deploy-to-cloud-btn/" class=""> Add a Deploy to Docker Cloud button</a>
<a data-link href="../../../../docker-cloud/apps/auto-destroy/" class=""> Automatic container destroy</a>
<a data-link href="../../../../docker-cloud/apps/autorestart/" class=""> Automatic container restart</a>
<a data-link href="../../../../docker-cloud/apps/auto-redeploy/" class=""> Automatic service redeploy</a>
<a data-link href="../../../../docker-cloud/apps/load-balance-hello-world/" class=""> Create a proxy or load balancer</a>
<a data-link href="../../../../docker-cloud/apps/deploy-tags/" class=""> Deployment tags</a>
<a data-link href="../../../../docker-cloud/apps/stacks/" class=""> Manage service stacks</a>
<a data-link href="../../../../docker-cloud/apps/ports/" class=""> Publish and expose service or container ports</a>
<a data-link href="../../../../docker-cloud/apps/service-redeploy/" class=""> Redeploy running services</a>
<a data-link href="../../../../docker-cloud/apps/service-scaling/" class=""> Scale your service</a>
<a data-link href="../../../../docker-cloud/apps/api-roles/" class=""> Service API Roles</a>
<a data-link href="../../../../docker-cloud/apps/service-links/" class=""> Service discovery and links</a>
<a data-link href="../../../../docker-cloud/apps/stack-yaml-reference/" class=""> Stack YAML reference</a>
<a data-link href="../../../../docker-cloud/apps/triggers/" class=""> Use triggers</a>
<a data-link href="../../../../docker-cloud/apps/volumes/" class=""> Work with data volumes</a>
</div>
</article>
<article data-accordion>
<button data-control> Manage Builds and Images</button>
<div data-content>
<a data-link href="../../../../docker-cloud/builds/automated-build/" class=""> Automated builds</a>
<a data-link href="../../../../docker-cloud/builds/automated-testing/" class=""> Automated repository tests</a>
<a data-link href="../../../../docker-cloud/builds/repos/" class=""> Docker Cloud repositories</a>
<a data-link href="../../../../docker-cloud/builds/link-source/" class=""> Link to a source code repository</a>
<a data-link href="../../../../docker-cloud/builds/push-images/" class=""> Push images to Docker Cloud</a>
<a data-link href="../../../../docker-cloud/builds/image-scan/" class=""> Security Scanning in Docker Cloud</a>
</div>
</article>
<article data-accordion>
<button data-control> Manage Infrastructure</button>
<div data-content>
<a data-link href="../../../../docker-cloud/infrastructure/deployment-strategies/" class=""> Container distribution strategies</a>
<a data-link href="../../../../docker-cloud/infrastructure/link-aws/" class=""> Link to Amazon Web Services hosts</a>
<a data-link href="../../../../docker-cloud/infrastructure/link-do/" class=""> Link to DigitalOcean hosts</a>
<a data-link href="../../../../docker-cloud/infrastructure/link-azure/" class=""> Link to Microsoft Azure hosts</a>
<a data-link href="../../../../docker-cloud/infrastructure/link-packet/" class=""> Link to Packet hosts</a>
<a data-link href="../../../../docker-cloud/infrastructure/link-softlayer/" class=""> Link to SoftLayer hosts</a>
<a data-link href="../../../../docker-cloud/infrastructure/ssh-into-a-node/" class=""> SSH into a Docker Cloud-managed node</a>
<a data-link href="../../../../docker-cloud/infrastructure/docker-upgrade/" class=""> Upgrade Docker Engine on a node</a>
<a data-link href="../../../../docker-cloud/infrastructure/byoh/" class=""> Use the Docker Cloud Agent</a>
<a data-link href="../../../../docker-cloud/infrastructure/cloud-on-packet.net-faq/" class=""> Using Docker Cloud and Packet.net</a>
<a data-link href="../../../../docker-cloud/infrastructure/cloud-on-aws-faq/" class=""> Using Docker Cloud on AWS</a>
</div>
</article>
<a data-link href="../../../../docker-cloud/slack-integration/" class=""> Docker Cloud notifications in Slack</a>
<a data-link href="../../../../docker-cloud/installing-cli/" class=""> The Docker Cloud CLI</a>
<a data-link href="../../../../docker-cloud/docker-errors-faq/" class=""> Known Issues in Docker Cloud</a>
<a data-link href="../../../../apidocs/docker-cloud/" class=""> API reference</a>
<a data-link href="../../../../docker-cloud/release-notes/" class=""> Release Notes</a>
</div>
</article>
</section>
<section data-accordion>
<article data-accordion>
<button data-control> Docker Machine</button>
<div data-content>
<a data-link href="../../../../machine/overview/" class=""> Machine Overview</a>
<a data-link href="../../../../machine/install-machine/" class=""> Install Machine</a>
<a data-link href="../../../../machine/get-started/" class=""> Get started with a local VM</a>
<a data-link href="../../../../machine/get-started-cloud/" class=""> Provision hosts in the cloud</a>
<article data-accordion>
<button data-control> Learn by example</button>
<div data-content>
<a data-link href="../../../../machine/examples/ocean/" class=""> Provision Digital Ocean Droplets</a>
<a data-link href="../../../../machine/examples/aws/" class=""> Provision AWS EC2 Instances</a>
</div>
</article>
<a data-link href="../../../../machine/concepts/" class=""> Machine concepts and help</a>
<a data-link href="../../../../machine/migrate-to-machine/" class=""> Migrate from Boot2Docker to Machine</a>
<article data-accordion>
<button data-control> Command line reference</button>
<div data-content>
<a data-link href="../../../../machine/reference/active/" class=""> active</a>
<a data-link href="../../../../machine/reference/config/" class=""> config</a>
<a data-link href="../../../../machine/reference/create/" class=""> create</a>
<a data-link href="../../../../machine/reference/env/" class=""> env</a>
<a data-link href="../../../../machine/reference/help/" class=""> help</a>
<a data-link href="../../../../machine/reference/inspect/" class=""> inspect</a>
<a data-link href="../../../../machine/reference/ip/" class=""> ip</a>
<a data-link href="../../../../machine/reference/kill/" class=""> kill</a>
<a data-link href="../../../../machine/reference/ls/" class=""> ls</a>
<a data-link href="../../../../machine/reference/provision/" class=""> provision</a>
<a data-link href="../../../../machine/reference/regenerate-certs/" class=""> regenerate-certs</a>
<a data-link href="../../../../machine/reference/restart/" class=""> restart</a>
<a data-link href="../../../../machine/reference/rm/" class=""> rm</a>
<a data-link href="../../../../machine/reference/scp/" class=""> scp</a>
<a data-link href="../../../../machine/reference/ssh/" class=""> ssh</a>
<a data-link href="../../../../machine/reference/start/" class=""> start</a>
<a data-link href="../../../../machine/reference/status/" class=""> status</a>
<a data-link href="../../../../machine/reference/stop/" class=""> stop</a>
<a data-link href="../../../../machine/reference/upgrade/" class=""> upgrade</a>
<a data-link href="../../../../machine/reference/url/" class=""> url</a>
</div>
</article>
<article data-accordion>
<button data-control> Drivers</button>
<div data-content>
<a data-link href="../../../../machine/drivers/os-base/" class=""> Driver options and operating system defaults</a>
<a data-link href="../../../../machine/drivers/aws/" class=""> Amazon Web Services</a>
<a data-link href="../../../../machine/drivers/digital-ocean/" class=""> Digital Ocean</a>
<a data-link href="../../../../machine/drivers/generic/" class=""> Generic</a>
<a data-link href="../../../../machine/drivers/gce/" class=""> Google Compute Engine</a>
<a data-link href="../../../../machine/drivers/soft-layer/" class=""> IBM Softlayer</a>
<a data-link href="../../../../machine/drivers/azure/" class=""> Microsoft Azure</a>
<a data-link href="../../../../machine/drivers/hyper-v/" class=""> Microsoft Hyper-V</a>
<a data-link href="../../../../machine/drivers/openstack/" class=""> OpenStack</a>
<a data-link href="../../../../machine/drivers/virtualbox/" class=""> Oracle VirtualBox</a>
<a data-link href="../../../../machine/drivers/rackspace/" class=""> Rackspace</a>
<a data-link href="../../../../machine/drivers/vm-fusion/" class=""> VMware Fusion</a>
<a data-link href="../../../../machine/drivers/vm-cloud/" class=""> VMware vCloud Air</a>
<a data-link href="../../../../machine/drivers/vsphere/" class=""> VMware vSphere</a>
<a data-link href="../../../../machine/drivers/exoscale/" class=""> exoscale</a>
</div>
</article>
<a data-link href="../../../../machine/completion/" class=""> Command-line Completion</a>
</div>
</article>
</section>
<section data-accordion>
<article data-accordion>
<button data-control> Docker Toolbox</button>
<div data-content>
<a data-link href="../../../../toolbox/overview/" class=""> Toolbox Overview</a>
<article data-accordion>
<button data-control> Kitematic</button>
<div data-content>
<a data-link href="../../../../kitematic/userguide/" class=""> Kitematic User Guide: Intro &amp; Overview</a>
<a data-link href="../../../../kitematic/nginx-web-server/" class=""> Set up an Nginx web server</a>
<a data-link href="../../../../kitematic/minecraft-server/" class=""> Set up a Minecraft Server</a>
<a data-link href="../../../../kitematic/rethinkdb-dev-database/" class=""> Creating a Local RethinkDB Database for Development</a>
<a data-link href="../../../../kitematic/faq/" class=""> Frequently Asked Questions</a>
<a data-link href="../../../../kitematic/known-issues/" class=""> Known Issues</a>
</div>
</article>
<a data-link href="../../../../faqs/troubleshoot/" class=""> Troubleshooting</a>
</div>
</article>
</section>
<section data-accordion>
<article data-accordion>
<button data-control> Component Projects</button>
<div data-content>
<article data-accordion>
<button data-control> Docker Registry</button>
<div data-content>
<a data-link href="../../../../registry/" class=""> Registry Overview</a>
<a data-link href="../../../../registry/introduction/" class=""> Understanding the Registry</a>
<a data-link href="../../../../registry/deploying/" class=""> Deploying a registry server</a>
<a data-link href="../../../../registry/configuration/" class=""> Configuring a registry</a>
<a data-link href="../../../../registry/notifications/" class=""> Working with notifications</a>
<article data-accordion>
<button data-control> Recipes</button>
<div data-content>
<a data-link href="../../../../registry/recipes/" class=""> Recipes Overview</a>
<a data-link href="../../../../registry/recipes/apache/" class=""> Authenticating proxy with apache</a>
<a data-link href="../../../../registry/recipes/nginx/" class=""> Authenticating proxy with nginx</a>
<a data-link href="../../../../registry/recipes/building/" class=""> Build instructions</a>
<a data-link href="../../../../registry/recipes/mirror/" class=""> Mirroring Docker Hub</a>
<a data-link href="../../../../registry/recipes/osx-setup-guide/" class=""> Running on OS X</a>
</div>
</article>
<article data-accordion>
<button data-control> Reference</button>
<div data-content>
<a data-link href="../../../../registry/spec/" class=""> Reference Overview</a>
<a data-link href="../../../../registry/spec/api/" class=""> HTTP API V2</a>
<a data-link href="../../../../registry/spec/manifest-v2-1/" class=""> Image Manifest V 2, Schema 1 </a>
<a data-link href="../../../../registry/spec/manifest-v2-2/" class=""> Image Manifest V 2, Schema 2 </a>
<a data-link href="../../../../registry/garbage-collection/" class=""> Garbage Collection</a>
<a data-link href="../../../../registry/insecure/" class=""> Testing an insecure registry</a>
<a data-link href="../../../../registry/compatibility/" class=""> Compatibility</a>
<a data-link href="../../../../registry/spec/auth/" class=""> Docker Registry Token Authentication</a>
<a data-link href="../../../../registry/spec/auth/jwt/" class=""> Token Authentication Implementation</a>
<a data-link href="../../../../registry/spec/auth/oauth/" class=""> Oauth2 Token Authentication</a>
<a data-link href="../../../../registry/spec/auth/scope/" class=""> Token Scope Documentation</a>
<a data-link href="../../../../registry/spec/auth/token/" class=""> Token Authentication Specification</a>
</div>
</article>
<article data-accordion>
<button data-control> Storage Drivers</button>
<div data-content>
<a data-link href="../../../../registry/storage-drivers/" class=""> Storage Driver overview</a>
<a data-link href="../../../../registry/storage-drivers/oss/" class=""> Aliyun OSS storage driver</a>
<a data-link href="../../../../registry/storage-drivers/filesystem/" class=""> Filesystem storage driver</a>
<a data-link href="../../../../registry/storage-drivers/gcs/" class=""> GCS storage driver</a>
<a data-link href="../../../../registry/storage-drivers/inmemory/" class=""> In-memory storage driver</a>
<a data-link href="../../../../registry/storage-drivers/azure/" class=""> Microsoft Azure storage driver</a>
<a data-link href="../../../../registry/storage-drivers/s3/" class=""> S3 storage driver</a>
<a data-link href="../../../../registry/storage-drivers/swift/" class=""> Swift storage driver</a>
</div>
</article>
<a data-link href="../../../../registry/help/" class=""> Getting help</a>
</div>
</article>
<article data-accordion>
<button data-control> Docker Notary</button>
<div data-content>
<a data-link href="../../../../notary/getting_started/" class=""> Getting started with Notary</a>
<a data-link href="../../../../notary/advanced_usage/" class=""> Use the Notary client</a>
<a data-link href="../../../../notary/service_architecture/" class=""> Understand the service architecture</a>
<a data-link href="../../../../notary/running_a_service/" class=""> Running a Notary service</a>
<article data-accordion>
<button data-control> Notary Configuration</button>
<div data-content>
<a data-link href="../../../../notary/reference/server-config/" class=""> Server Configuration</a>
<a data-link href="../../../../notary/reference/signer-config/" class=""> Signer Configuration</a>
<a data-link href="../../../../notary/reference/client-config/" class=""> Client Configuration</a>
<a data-link href="../../../../notary/reference/common-configs/" class=""> Common Server and Signer Configurations</a>
</div>
</article>
<a data-link href="../../../../notary/changelog/" class=""> Notary Changelog</a>
</div>
</article>
</div>
</article>
</section>
<section data-accordion>
<article data-accordion>
<button data-control> Open Source at Docker</button>
<div data-content>
<a data-link href="../../../../opensource/code/" class=""> Quickstart contribution</a>
<article data-accordion>
<button data-control> Set up for Engine Development</button>
<div data-content>
<a data-link href="../../../../opensource/project/who-written-for/" class=""> README first</a>
<a data-link href="../../../../opensource/project/software-required/" class=""> Get the required software</a>
<a data-link href="../../../../opensource/project/software-req-win/" class=""> Set up for development on Windows</a>
<a data-link href="../../../../opensource/project/set-up-git/" class=""> Configure Git for contributing</a>
<a data-link href="../../../../opensource/project/set-up-dev-env/" class=""> Work with a development container</a>
<a data-link href="../../../../opensource/project/test-and-docs/" class=""> Run tests and test documentation</a>
</div>
</article>
<article data-accordion>
<button data-control> Contribution workflow</button>
<div data-content>
<a data-link href="../../../../opensource/workflow/make-a-contribution/" class=""> Understand how to contribute</a>
<a data-link href="../../../../opensource/workflow/find-an-issue/" class=""> Find and claim an issue</a>
<a data-link href="../../../../opensource/workflow/work-issue/" class=""> Work on your issue</a>
<a data-link href="../../../../opensource/workflow/create-pr/" class=""> Create a pull request (PR)</a>
<a data-link href="../../../../opensource/workflow/review-pr/" class=""> Participate in the PR review</a>
<a data-link href="../../../../opensource/workflow/advanced-contributing/" class=""> Advanced contributing</a>
<a data-link href="../../../../opensource/workflow/coding-style/" class=""> Coding style checklist</a>
</div>
</article>
<article data-accordion>
<button data-control> Other ways to contribute</button>
<div data-content>
<a data-link href="../../../../opensource/ways/meetups/" class=""> Organize a Docker Meetup</a>
<a data-link href="../../../../opensource/ways/issues/" class=""> Organize our issues</a>
<a data-link href="../../../../opensource/ways/community/" class=""> Support the community</a>
<a data-link href="../../../../opensource/ways/test/" class=""> Testing contributions</a>
</div>
</article>
<article data-accordion>
<button data-control> Contribute to Kitematic</button>
<div data-content>
<a data-link href="../../../../opensource/kitematic/get_started/" class=""> Get started</a>
<a data-link href="../../../../opensource/kitematic/find_issue/" class=""> Find an issue</a>
<a data-link href="../../../../opensource/kitematic/set_up_dev/" class=""> Set up for Kitematic development</a>
<a data-link href="../../../../opensource/kitematic/work_issue/" class=""> Develop in Kitematic (work on an issue)</a>
<a data-link href="../../../../opensource/kitematic/create_pr/" class=""> Create a pull request (PR)</a>
<a data-link href="../../../../opensource/kitematic/next_steps/" class=""> Where to learn more</a>
</div>
</article>
<article data-accordion>
<button data-control> Governance</button>
<div data-content>
<a data-link href="../../../../opensource/governance/dgab-info/" class=""> Docker Governance Advisory Board</a>
<a data-link href="../../../../opensource/governance/board-profiles/" class=""> Board member profiles</a>
<a data-link href="../../../../opensource/governance/conduct-code/" class=""> Code of conduct</a>
</div>
</article>
<a data-link href="../../../../opensource/FAQ/" class=""> FAQ for contributors</a>
<a data-link href="../../../../opensource/get-help/" class=""> Where to chat or get help</a>
<a data-link href="../../../../opensource/doc-style/" class=""> Style guide for Docker documentation</a>
</div>
</article>
</section>
<section data-accordion>
<article data-accordion>
<button data-control> About</button>
<div data-content>
<a data-link href="../../../../release-notes/" class=""> Docker Release Notes</a>
<a data-link href="../../../../engine/reference/glossary/" class=""> Docker Glossary</a>
</div>
</article>
</section>
<section data-accordion>
<article data-accordion>
<button style="visibility: hidden" data-control> Docs archive</button>
<div data-content>
<a data-link href="http://docs.docker.com/v1.10/" class=""> Version 1.10</a>
<a data-link href="http://docs.docker.com/v1.9/" class=""> Version 1.9</a>
<a data-link href="http://docs.docker.com/v1.8/" class=""> Version 1.8</a>
<a data-link href="http://docs.docker.com/v1.7/" class=""> Version 1.7</a>
<a data-link href="http://docs.docker.com/v1.6/" class=""> Version 1.6</a>
<a data-link href="http://docs.docker.com/v1.5/" class=""> Version 1.5</a>
<a data-link href="http://docs.docker.com/v1.4/" class=""> Version 1.4</a>
</div>
</article>
</section>
</section>
<script>
$(document).ready(function () {
var $activeLink = $('#multiple [data-link].active');
var $accordions = $activeLink.parents('article[data-accordion]');
$($accordions.get().reverse()).each(function (index, accordion) {
var $accordion = $(accordion);
var $content = $accordion.find('[data-content]');
$accordion.addClass('open');
$content.css({'max-height': '100%'});
});
});
</script>
</div>
<div class="large-6 columns">
<section id="main">
<article id="content">
<h1 id="docker-remote-api">Docker Remote API</h1>
<p>Docker&rsquo;s Remote API uses an open schema model. In this model, unknown
properties in incoming messages are ignored. Client applications need to take
this behavior into account to ensure they do not break when talking to newer
Docker daemons.</p>
<p>The API tends to be REST, but for some complex commands, like attach or pull,
the HTTP connection is hijacked to transport STDOUT, STDIN, and STDERR.</p>
<p>By default the Docker daemon listens on <code>unix:///var/run/docker.sock</code> and the
client must have <code>root</code> access to interact with the daemon. If a group named
<code>docker</code> exists on your system, <code>docker</code> applies ownership of the socket to the
group.</p>
<p>To connect to the Docker daemon with cURL you need to use cURL 7.40 or
later, as these versions have the <code>--unix-socket</code> flag available. To
run <code>curl</code> against the daemon on the default socket, use the
following:</p>
<pre><code>curl --unix-socket /var/run/docker.sock http:/containers/json
</code></pre>
<p>If you have bound the Docker daemon to a different socket path or TCP
port, you would reference that in your cURL rather than the
default.</p>
<p>The current version of the API is v1.23 which means calling <code>/info</code> is the same
as calling <code>/v1.23/info</code>. To call an older version of the API use
<code>/v1.22/info</code>.</p>
<p>Use the table below to find the API version for a Docker version:</p>
<table>
<thead>
<tr>
<th>Docker version</th>
<th>API version</th>
<th>Changes</th>
</tr>
</thead>
<tbody>
<tr>
<td>1.11.x</td>
<td><a href="../../../../engine/reference/api/docker_remote_api_v1.23/">1.23</a></td>
<td><a href="../../../../engine/reference/api/docker_remote_api/#v1-23-api-changes">API changes</a></td>
</tr>
<tr>
<td>1.10.x</td>
<td><a href="../../../../engine/reference/api/docker_remote_api_v1.22/">1.22</a></td>
<td><a href="../../../../engine/reference/api/docker_remote_api/#v1-22-api-changes">API changes</a></td>
</tr>
<tr>
<td>1.9.x</td>
<td><a href="../../../../engine/reference/api/docker_remote_api_v1.21/">1.21</a></td>
<td><a href="../../../../engine/reference/api/docker_remote_api/#v1-21-api-changes">API changes</a></td>
</tr>
<tr>
<td>1.8.x</td>
<td><a href="../../../../engine/reference/api/docker_remote_api_v1.20/">1.20</a></td>
<td><a href="../../../../engine/reference/api/docker_remote_api/#v1-20-api-changes">API changes</a></td>
</tr>
<tr>
<td>1.7.x</td>
<td><a href="../../../../engine/reference/api/docker_remote_api_v1.19/">1.19</a></td>
<td><a href="../../../../engine/reference/api/docker_remote_api/#v1-19-api-changes">API changes</a></td>
</tr>
<tr>
<td>1.6.x</td>
<td><a href="../../../../engine/reference/api/docker_remote_api_v1.18/">1.18</a></td>
<td><a href="../../../../engine/reference/api/docker_remote_api/#v1-18-api-changes">API changes</a></td>
</tr>
</tbody>
</table>
<p>Refer to the <a href="https://github.com/docker/docker/tree/master/docs/reference/api">GitHub repository</a> for
older releases.</p>
<h2 id="authentication">Authentication</h2>
<p>Authentication configuration is handled client side, so the
client has to send the <code>authConfig</code> as a <code>POST</code> in <code>/images/(name)/push</code>. The
<code>authConfig</code>, set as the <code>X-Registry-Auth</code> header, is currently a Base64 encoded
(JSON) string with the following structure:</p>
<pre><code class="language-JSON">{&quot;username&quot;: &quot;string&quot;, &quot;password&quot;: &quot;string&quot;, &quot;email&quot;: &quot;string&quot;,
&quot;serveraddress&quot; : &quot;string&quot;, &quot;auth&quot;: &quot;&quot;}
</code></pre>
<p>Callers should leave the <code>auth</code> empty. The <code>serveraddress</code> is a domain/ip
without protocol. Throughout this structure, double quotes are required.</p>
<h2 id="using-docker-machine-with-the-api">Using Docker Machine with the API</h2>
<p>If you are using <code>docker-machine</code>, the Docker daemon is on a host that
uses an encrypted TCP socket using TLS. This means, for Docker Machine users,
you need to add extra parameters to <code>curl</code> or <code>wget</code> when making test
API requests, for example:</p>
<pre><code>curl --insecure \
--cert $DOCKER_CERT_PATH/cert.pem \
--key $DOCKER_CERT_PATH/key.pem \
https://YOUR_VM_IP:2376/images/json
wget --no-check-certificate --certificate=$DOCKER_CERT_PATH/cert.pem \
--private-key=$DOCKER_CERT_PATH/key.pem \
https://YOUR_VM_IP:2376/images/json -O - -q
</code></pre>
<h2 id="docker-events">Docker Events</h2>
<p>The following diagram depicts the container states accessible through the API.</p>
<p><img src="../../../../engine/reference/api/images/event_state.png" alt="States" /></p>
<p>Some container-related events are not affected by container state, so they are not included in this diagram. These events are:</p>
<ul>
<li><strong>export</strong> emitted by <code>docker export</code></li>
<li><strong>exec_create</strong> emitted by <code>docker exec</code></li>
<li><strong>exec_start</strong> emitted by <code>docker exec</code> after <strong>exec_create</strong></li>
</ul>
<p>Running <code>docker rmi</code> emits an <strong>untag</strong> event when removing an image name. The <code>rmi</code> command may also emit <strong>delete</strong> events when images are deleted by ID directly or by deleting the last tag referring to the image.</p>
<blockquote>
<p><strong>Acknowledgment</strong>: This diagram and the accompanying text were used with the permission of Matt Good and Gilder Labs. See Matt&rsquo;s original blog post <a href="https://gliderlabs.com/blog/2015/04/14/docker-events-explained/">Docker Events Explained</a>.</p>
</blockquote>
<h2 id="version-history">Version history</h2>
<p>This section lists each version from latest to oldest. Each listing includes a link to the full documentation set and the changes relevant in that release.</p>
<h3 id="v1-23-api-changes">v1.23 API changes</h3>
<p><a href="../../../../engine/reference/api/docker_remote_api_v1.23/">Docker Remote API v1.23</a> documentation</p>
<ul>
<li><code>GET /containers/json</code> returns the state of the container, one of <code>created</code>, <code>restarting</code>, <code>running</code>, <code>paused</code>, <code>exited</code> or <code>dead</code>.</li>
<li><code>GET /containers/json</code> returns the mount points for the container.</li>
<li><code>GET /networks/(name)</code> now returns an <code>Internal</code> field showing whether the network is internal or not.</li>
<li><code>GET /networks/(name)</code> now returns an <code>EnableIPv6</code> field showing whether the network has ipv6 enabled or not.</li>
<li><code>POST /containers/(name)/update</code> now supports updating container&rsquo;s restart policy.</li>
<li><code>POST /networks/create</code> now supports enabling ipv6 on the network by setting the <code>EnableIPv6</code> field (doing this with a label will no longer work).</li>
<li><code>GET /info</code> now returns <code>CgroupDriver</code> field showing what cgroup driver the daemon is using; <code>cgroupfs</code> or <code>systemd</code>.</li>
<li><code>GET /info</code> now returns <code>KernelMemory</code> field, showing if &ldquo;kernel memory limit&rdquo; is supported.</li>
<li><code>POST /containers/create</code> now takes <code>PidsLimit</code> field, if the kernel is &gt;= 4.3 and the pids cgroup is supported.</li>
<li><code>GET /containers/(id or name)/stats</code> now returns <code>pids_stats</code>, if the kernel is &gt;= 4.3 and the pids cgroup is supported.</li>
<li><code>POST /containers/create</code> now allows you to override usernamespaces remapping and use privileged options for the container.</li>
<li><code>POST /containers/create</code> now allows specifying <code>nocopy</code> for named volumes, which disables automatic copying from the container path to the volume.</li>
<li><code>POST /auth</code> now returns an <code>IdentityToken</code> when supported by a registry.</li>
<li><code>POST /containers/create</code> with both <code>Hostname</code> and <code>Domainname</code> fields specified will result in the container&rsquo;s hostname being set to <code>Hostname</code>, rather than <code>Hostname.Domainname</code>.</li>
</ul>
<h3 id="v1-22-api-changes">v1.22 API changes</h3>
<p><a href="../../../../engine/reference/api/docker_remote_api_v1.22/">Docker Remote API v1.22</a> documentation</p>
<ul>
<li><code>POST /container/(name)/update</code> updates the resources of a container.</li>
<li><code>GET /containers/json</code> supports filter <code>isolation</code> on Windows.</li>
<li><code>GET /containers/json</code> now returns the list of networks of containers.</li>
<li><code>GET /info</code> Now returns <code>Architecture</code> and <code>OSType</code> fields, providing information
about the host architecture and operating system type that the daemon runs on.</li>
<li><code>GET /networks/(name)</code> now returns a <code>Name</code> field for each container attached to the network.</li>
<li><code>GET /version</code> now returns the <code>BuildTime</code> field in RFC3339Nano format to make it
consistent with other date/time values returned by the API.</li>
<li><code>AuthConfig</code> now supports a <code>registrytoken</code> for token based authentication</li>
<li><code>POST /containers/create</code> now has a 4M minimum value limit for <code>HostConfig.KernelMemory</code></li>
<li>Pushes initiated with <code>POST /images/(name)/push</code> and pulls initiated with <code>POST /images/create</code>
will be cancelled if the HTTP connection making the API request is closed before
the push or pull completes.</li>
<li><code>POST /containers/create</code> now allows you to set a read/write rate limit for a
device (in bytes per second or IO per second).</li>
<li><code>GET /networks</code> now supports filtering by <code>name</code>, <code>id</code> and <code>type</code>.</li>
<li><code>POST /containers/create</code> now allows you to set the static IPv4 and/or IPv6 address for the container.</li>
<li><code>POST /networks/(id)/connect</code> now allows you to set the static IPv4 and/or IPv6 address for the container.</li>
<li><code>GET /info</code> now includes the number of containers running, stopped, and paused.</li>
<li><code>POST /networks/create</code> now supports restricting external access to the network by setting the <code>Internal</code> field.</li>
<li><code>POST /networks/(id)/disconnect</code> now includes a <code>Force</code> option to forcefully disconnect a container from network</li>
<li><code>GET /containers/(id)/json</code> now returns the <code>NetworkID</code> of containers.</li>
<li><code>POST /networks/create</code> Now supports an options field in the IPAM config that provides options
for custom IPAM plugins.</li>
<li><code>GET /networks/{network-id}</code> Now returns IPAM config options for custom IPAM plugins if any
are available.</li>
<li><code>GET /networks/&lt;network-id&gt;</code> now returns subnets info for user-defined networks.</li>
<li><code>GET /info</code> can now return a <code>SystemStatus</code> field useful for returning additional information about applications
that are built on top of engine.</li>
</ul>
<h3 id="v1-21-api-changes">v1.21 API changes</h3>
<p><a href="../../../../engine/reference/api/docker_remote_api_v1.21/">Docker Remote API v1.21</a> documentation</p>
<ul>
<li><code>GET /volumes</code> lists volumes from all volume drivers.</li>
<li><code>POST /volumes/create</code> to create a volume.</li>
<li><code>GET /volumes/(name)</code> get low-level information about a volume.</li>
<li><code>DELETE /volumes/(name)</code> remove a volume with the specified name.</li>
<li><code>VolumeDriver</code> was moved from <code>config</code> to <code>HostConfig</code> to make the configuration portable.</li>
<li><code>GET /images/(name)/json</code> now returns information about an image&rsquo;s <code>RepoTags</code> and <code>RepoDigests</code>.</li>
<li>The <code>config</code> option now accepts the field <code>StopSignal</code>, which specifies the signal to use to kill a container.</li>
<li><code>GET /containers/(id)/stats</code> will return networking information respectively for each interface.</li>
<li>The <code>HostConfig</code> option now includes the <code>DnsOptions</code> field to configure the container&rsquo;s DNS options.</li>
<li><code>POST /build</code> now optionally takes a serialized map of build-time variables.</li>
<li><code>GET /events</code> now includes a <code>timenano</code> field, in addition to the existing <code>time</code> field.</li>
<li><code>GET /events</code> now supports filtering by image and container labels.</li>
<li><code>GET /info</code> now lists engine version information and return the information of <code>CPUShares</code> and <code>Cpuset</code>.</li>
<li><code>GET /containers/json</code> will return <code>ImageID</code> of the image used by container.</li>
<li><code>POST /exec/(name)/start</code> will now return an HTTP 409 when the container is either stopped or paused.</li>
<li><code>GET /containers/(name)/json</code> now accepts a <code>size</code> parameter. Setting this parameter to &lsquo;1&rsquo; returns container size information in the <code>SizeRw</code> and <code>SizeRootFs</code> fields.</li>
<li><code>GET /containers/(name)/json</code> now returns a <code>NetworkSettings.Networks</code> field,
detailing network settings per network. This field deprecates the
<code>NetworkSettings.Gateway</code>, <code>NetworkSettings.IPAddress</code>,
<code>NetworkSettings.IPPrefixLen</code>, and <code>NetworkSettings.MacAddress</code> fields, which
are still returned for backward-compatibility, but will be removed in a future version.</li>
<li><code>GET /exec/(id)/json</code> now returns a <code>NetworkSettings.Networks</code> field,
detailing networksettings per network. This field deprecates the
<code>NetworkSettings.Gateway</code>, <code>NetworkSettings.IPAddress</code>,
<code>NetworkSettings.IPPrefixLen</code>, and <code>NetworkSettings.MacAddress</code> fields, which
are still returned for backward-compatibility, but will be removed in a future version.</li>
<li>The <code>HostConfig</code> option now includes the <code>OomScoreAdj</code> field for adjusting the
badness heuristic. This heuristic selects which processes the OOM killer kills
under out-of-memory conditions.</li>
</ul>
<h3 id="v1-20-api-changes">v1.20 API changes</h3>
<p><a href="../../../../engine/reference/api/docker_remote_api_v1.20/">Docker Remote API v1.20</a> documentation</p>
<ul>
<li><code>GET /containers/(id)/archive</code> get an archive of filesystem content from a container.</li>
<li><code>PUT /containers/(id)/archive</code> upload an archive of content to be extracted to
an existing directory inside a container&rsquo;s filesystem.</li>
<li><code>POST /containers/(id)/copy</code> is deprecated in favor of the above <code>archive</code>
endpoint which can be used to download files and directories from a container.</li>
<li>The <code>hostConfig</code> option now accepts the field <code>GroupAdd</code>, which specifies a
list of additional groups that the container process will run as.</li>
</ul>
<h3 id="v1-19-api-changes">v1.19 API changes</h3>
<p><a href="../../../../engine/reference/api/docker_remote_api_v1.19/">Docker Remote API v1.19</a> documentation</p>
<ul>
<li>When the daemon detects a version mismatch with the client, usually when
the client is newer than the daemon, an HTTP 400 is now returned instead
of a 404.</li>
<li><code>GET /containers/(id)/stats</code> now accepts <code>stream</code> bool to get only one set of stats and disconnect.</li>
<li><code>GET /containers/(id)/logs</code> now accepts a <code>since</code> timestamp parameter.</li>
<li><code>GET /info</code> The fields <code>Debug</code>, <code>IPv4Forwarding</code>, <code>MemoryLimit</code>, and
<code>SwapLimit</code> are now returned as boolean instead of as an int. In addition, the
end point now returns the new boolean fields <code>CpuCfsPeriod</code>, <code>CpuCfsQuota</code>, and
<code>OomKillDisable</code>.</li>
<li>The <code>hostConfig</code> option now accepts the fields <code>CpuPeriod</code> and <code>CpuQuota</code></li>
<li><code>POST /build</code> accepts <code>cpuperiod</code> and <code>cpuquota</code> options</li>
</ul>
<h3 id="v1-18-api-changes">v1.18 API changes</h3>
<p><a href="../../../../engine/reference/api/docker_remote_api_v1.18/">Docker Remote API v1.18</a> documentation</p>
<ul>
<li><code>GET /version</code> now returns <code>Os</code>, <code>Arch</code> and <code>KernelVersion</code>.</li>
<li><code>POST /containers/create</code> and <code>POST /containers/(id)/start</code>allow you to set ulimit settings for use in the container.</li>
<li><code>GET /info</code> now returns <code>SystemTime</code>, <code>HttpProxy</code>,<code>HttpsProxy</code> and <code>NoProxy</code>.</li>
<li><code>GET /images/json</code> added a <code>RepoDigests</code> field to include image digest information.</li>
<li><code>POST /build</code> can now set resource constraints for all containers created for the build.</li>
<li><code>CgroupParent</code> can be passed in the host config to setup container cgroups under a specific cgroup.</li>
<li><code>POST /build</code> closing the HTTP request cancels the build</li>
<li><code>POST /containers/(id)/exec</code> includes <code>Warnings</code> field to response.</li>
</ul>
</article>
</section>
</div>
<div id="toc" class="large-3 columns toc ">
On this page:
<nav id="TableOfContents">
<ul>
<li><a href="#docker-remote-api">Docker Remote API</a>
<ul>
<li><a href="#authentication">Authentication</a></li>
<li><a href="#using-docker-machine-with-the-api">Using Docker Machine with the API</a></li>
<li><a href="#docker-events">Docker Events</a></li>
<li><a href="#version-history">Version history</a>
<ul>
<li><a href="#v1-23-api-changes">v1.23 API changes</a></li>
<li><a href="#v1-22-api-changes">v1.22 API changes</a></li>
<li><a href="#v1-21-api-changes">v1.21 API changes</a></li>
<li><a href="#v1-20-api-changes">v1.20 API changes</a></li>
<li><a href="#v1-19-api-changes">v1.19 API changes</a></li>
<li><a href="#v1-18-api-changes">v1.18 API changes</a></li>
</ul></li>
</ul></li>
</ul>
</nav>
</div>
</div>
<footer class="main-footer">
<div class="row">
</div>
<div class="row">
</div>
</footer>
<link rel="stylesheet" href="../../../../highlight/styles/github.css">
<script src="../../../../highlight/highlight.pack.js"></script>
<script>hljs.initHighlightingOnLoad();</script>
<script src="../../../../dist/assets/js/all.js"></script>
<script>
$( 'nav li:has(ul)' ).doubleTapToGo();
</script>
<script>
;(function ( $, window, document, undefined ) {
var pluginName = 'accordion',
defaults = {
transitionSpeed: 300,
transitionEasing: 'ease',
controlElement: '[data-control]',
contentElement: '[data-content]',
groupElement: '[data-accordion-group]',
singleOpen: true
};
function Accordion(element, options) {
this.element = element;
this.options = $.extend({}, defaults, options);
this._defaults = defaults;
this._name = pluginName;
this.init();
}
Accordion.prototype.init = function () {
var self = this,
opts = self.options;
var $accordion = $(self.element),
$controls = $accordion.find('> ' + opts.controlElement),
$content = $accordion.find('> ' + opts.contentElement);
var accordionParentsQty = $accordion.parents('[data-accordion]').length,
accordionHasParent = accordionParentsQty > 0;
var closedCSS = { 'max-height': 0, 'overflow': 'hidden' };
var CSStransitions = supportsTransitions();
function debounce(func, threshold, execAsap) {
var timeout;
return function debounced() {
var obj = this,
args = arguments;
function delayed() {
if (!execAsap) func.apply(obj, args);
timeout = null;
};
if (timeout) clearTimeout(timeout);
else if (execAsap) func.apply(obj, args);
timeout = setTimeout(delayed, threshold || 100);
};
}
function supportsTransitions() {
var b = document.body || document.documentElement,
s = b.style,
p = 'transition';
if (typeof s[p] == 'string') {
return true;
}
var v = ['Moz', 'webkit', 'Webkit', 'Khtml', 'O', 'ms'];
p = 'Transition';
for (var i=0; i<v.length; i++) {
if (typeof s[v[i] + p] == 'string') {
return true;
}
}
return false;
}
function requestAnimFrame(cb) {
if(window.requestAnimationFrame || window.webkitRequestAnimationFrame || window.mozRequestAnimationFrame) {
return requestAnimationFrame(cb) ||
webkitRequestAnimationFrame(cb) ||
mozRequestAnimationFrame(cb);
} else {
return setTimeout(cb, 1000 / 60);
}
}
function toggleTransition($el, remove) {
if(!remove) {
$content.css({
'-webkit-transition': 'max-height ' + opts.transitionSpeed + 'ms ' + opts.transitionEasing,
'transition': 'max-height ' + opts.transitionSpeed + 'ms ' + opts.transitionEasing
});
} else {
$content.css({
'-webkit-transition': '',
'transition': ''
});
}
}
function calculateHeight($el) {
var height = 0;
$el.children().each(function() {
height = height + $(this).outerHeight(true);
});
$el.data('oHeight', height);
}
function updateParentHeight($parentAccordion, $currentAccordion, qty, operation) {
var $content = $parentAccordion.filter('.open').find('> [data-content]'),
$childs = $content.find('[data-accordion].open > [data-content]'),
$matched;
if(!opts.singleOpen) {
$childs = $childs.not($currentAccordion.siblings('[data-accordion].open').find('> [data-content]'));
}
$matched = $content.add($childs);
if($parentAccordion.hasClass('open')) {
$matched.each(function() {
var currentHeight = $(this).data('oHeight');
switch (operation) {
case '+':
$(this).data('oHeight', currentHeight + qty);
break;
case '-':
$(this).data('oHeight', currentHeight - qty);
break;
default:
throw 'updateParentHeight method needs an operation';
}
$(this).css('max-height', $(this).data('oHeight'));
});
}
}
function refreshHeight($accordion) {
if($accordion.hasClass('open')) {
var $content = $accordion.find('> [data-content]'),
$childs = $content.find('[data-accordion].open > [data-content]'),
$matched = $content.add($childs);
calculateHeight($matched);
$matched.css('max-height', $matched.data('oHeight'));
}
}
function closeAccordion($accordion, $content) {
$accordion.trigger('accordion.close');
if(CSStransitions) {
if(accordionHasParent) {
var $parentAccordions = $accordion.parents('[data-accordion]');
updateParentHeight($parentAccordions, $accordion, $content.data('oHeight'), '-');
}
$content.css(closedCSS);
$accordion.removeClass('open');
} else {
$content.css('max-height', $content.data('oHeight'));
$content.animate(closedCSS, opts.transitionSpeed);
$accordion.removeClass('open');
}
}
function openAccordion($accordion, $content) {
$accordion.trigger('accordion.open');
if(CSStransitions) {
toggleTransition($content);
if(accordionHasParent) {
var $parentAccordions = $accordion.parents('[data-accordion]');
updateParentHeight($parentAccordions, $accordion, $content.data('oHeight'), '+');
}
requestAnimFrame(function() {
$content.css('max-height', $content.data('oHeight'));
});
$accordion.addClass('open');
} else {
$content.animate({
'max-height': $content.data('oHeight')
}, opts.transitionSpeed, function() {
$content.css({'max-height': 'none'});
});
$accordion.addClass('open');
}
}
function closeSiblingAccordions($accordion) {
var $accordionGroup = $accordion.closest(opts.groupElement);
var $siblings = $accordion.siblings('[data-accordion]').filter('.open'),
$siblingsChildren = $siblings.find('[data-accordion]').filter('.open');
var $otherAccordions = $siblings.add($siblingsChildren);
$otherAccordions.each(function() {
var $accordion = $(this),
$content = $accordion.find(opts.contentElement);
closeAccordion($accordion, $content);
});
$otherAccordions.removeClass('open');
}
function toggleAccordion() {
var isAccordionGroup = (opts.singleOpen) ? $accordion.parents(opts.groupElement).length > 0 : false;
calculateHeight($content);
if(isAccordionGroup) {
closeSiblingAccordions($accordion);
}
if($accordion.hasClass('open')) {
closeAccordion($accordion, $content);
} else {
openAccordion($accordion, $content);
}
}
function addEventListeners() {
$controls.on('click', toggleAccordion);
$controls.on('accordion.toggle', function() {
if(opts.singleOpen && $controls.length > 1) {
return false;
}
toggleAccordion();
});
$(window).on('resize', debounce(function() {
refreshHeight($accordion);
}));
}
function setup() {
$content.each(function() {
var $curr = $(this);
if($curr.css('max-height') != 0) {
if(!$curr.closest('[data-accordion]').hasClass('open')) {
$curr.css({ 'max-height': 0, 'overflow': 'hidden' });
} else {
toggleTransition($curr);
calculateHeight($curr);
$curr.css('max-height', $curr.data('oHeight'));
}
}
});
if(!$accordion.attr('data-accordion')) {
$accordion.attr('data-accordion', '');
$accordion.find(opts.controlElement).attr('data-control', '');
$accordion.find(opts.contentElement).attr('data-content', '');
}
}
setup();
addEventListeners();
};
$.fn[pluginName] = function ( options ) {
return this.each(function () {
if (!$.data(this, 'plugin_' + pluginName)) {
$.data(this, 'plugin_' + pluginName,
new Accordion( this, options ));
}
});
}
})( jQuery, window, document );
$(document).ready(function() {
$('#multiple [data-accordion]').accordion({
singleOpen: false
});
});
</script>
<script src="/dist/assets/js/archive.js"></script>
<script type="text/javascript">
!function(){var analytics=window.analytics=window.analytics||[];if(!analytics.initialize)if(analytics.invoked)window.console&&console.error&&console.error("Segment snippet included twice.");else{analytics.invoked=!0;analytics.methods=["trackSubmit","trackClick","trackLink","trackForm","pageview","identify","reset","group","track","ready","alias","debug","page","once","off","on"];analytics.factory=function(t){return function(){var e=Array.prototype.slice.call(arguments);e.unshift(t);analytics.push(e);return analytics}};for(var t=0;t<analytics.methods.length;t++){var e=analytics.methods[t];analytics[e]=analytics.factory(e)}analytics.load=function(t){var e=document.createElement("script");e.type="text/javascript";e.async=!0;e.src=("https:"===document.location.protocol?"https://":"http://")+"cdn.segment.com/analytics.js/v1/"+t+"/analytics.min.js";var n=document.getElementsByTagName("script")[0];n.parentNode.insertBefore(e,n)};analytics.SNIPPET_VERSION="4.0.0";
analytics.load("IWj9D0UpZHZdZUZX9jl98PcpBFWBnBMy");
analytics.page();
}}();
</script>
Reference in New Issue View Git Blame Copy Permalink